From 3678eebcd7274393c629b8f9f02b7458fe93d267 Mon Sep 17 00:00:00 2001 From: Dmitry Shirokov Date: Tue, 30 Apr 2013 23:57:19 +1000 Subject: [PATCH] updated readme file --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 22116b5..414972c 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ -chardet - nodejs characted detection module, written in pure Javascript -====== +# chardet - characted detection module, pure Javascript -# Installation +Chardet is a character detection module for NodeJS written in pure Javascript. +Module is based on ICU project http://site.icu-project.org/, which uses character +occurency analysis to determine the most probable encoding. + +## Installation npm install chardet -# Usage +## Usage var chardet = require('chardet'); chardet.detect(new Buffer('hello there!')); @@ -15,7 +18,7 @@ chardet - nodejs characted detection module, written in pure Javascript // or chardet.detectFileSync('/path/to/file'); -# Supported Encodings: +## Supported Encodings: * UTF-8 * UTF-16 LE