[Pkg-javascript-commits] [node-iconv-lite] 77/83: Update README.md

[matthew pideil]

This is an automated email from the git hooks/post-receive script.

mpideil-guest pushed a commit to branch master
in repository node-iconv-lite.

commit 328722b893b09be5f9211b6079d19b709e2523e6
Author: Alexander Shtuchkin <ashtuchkin at gmail.com>
Date:   Thu Dec 26 10:40:23 2013 -0800

    Update README.md
---
 README.md | 37 ++++++++++++++++++++-----------------
 1 file changed, 20 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index ba30a32..503b1e8 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,39 @@
-iconv-lite - pure javascript character encoding conversion
-======================================================================
+# Iconv-lite: character encoding conversion in javascript
 
+[![NPM Stats](https://nodei.co/npm/iconv-lite.png?downloads=true)](https://npmjs.org/packages/iconv-lite/)
 [![Build Status](https://secure.travis-ci.org/ashtuchkin/iconv-lite.png?branch=master)](http://travis-ci.org/ashtuchkin/iconv-lite)
 
 ## Features
 
-*   Pure javascript. Doesn't need native code compilation.
-*   Easy API.
-*   Works on Windows and in sandboxed environments like [Cloud9](http://c9.io).
-*   Encoding is much faster than node-iconv (see below for performance comparison).
+ * Doesn't need native code compilation. Works on Windows and in sandboxed environments like [Cloud9](http://c9.io).
+ * Intuitive encode/decode API.
+ * Encoding is faster than [node-iconv](https://github.com/bnoordhuis/node-iconv) (see below for performance comparison).
+ * Used in popular projects like [Grunt](http://gruntjs.com/), [Nodemailer](http://www.nodemailer.com/), [Yeoman](http://yeoman.io/) and others.
+ * License: MIT.
 
 ## Usage
 
     var iconv = require('iconv-lite');
     
-    // Convert from an encoded buffer to string.
+    // Convert from an encoded buffer to js string.
     str = iconv.decode(buf, 'win1251');
     
-    // Convert from string to an encoded buffer.
+    // Convert from js string to an encoded buffer.
     buf = iconv.encode("Sample input string", 'win1251');
 
     // Check if encoding is supported
     iconv.encodingExists("us-ascii")
 
-
 ## Supported encodings
 
-*   All node.js native encodings: 'utf8', 'ucs2', 'ascii', 'binary', 'base64'
-*   All widespread single byte encodings: Windows 125x family, ISO-8859 family, 
+ *  All node.js native encodings: 'utf8', 'ucs2', 'ascii', 'binary', 'base64'
+ *  All widespread single byte encodings: Windows 125x family, ISO-8859 family, 
     IBM/DOS codepages, Macintosh family, KOI8 family. 
     Aliases like 'latin1', 'us-ascii' also supported.
-*   Multibyte encodings: 'gbk', 'gb2313', 'Big5', 'cp950'.
+ *  Multibyte encodings: 'gbk', 'gb2313', 'Big5', 'cp950'.
 
 Others are easy to add, see the source. Please, participate.
-Most encodings are generated from node-iconv. Thank you Ben Noordhuis and iconv authors!
+Most encodings are generated automatically from [node-iconv](https://github.com/bnoordhuis/node-iconv). Thank you Ben Noordhuis and iconv authors!
 
 Not supported yet: EUC family, Shift_JIS.
 
@@ -66,7 +66,10 @@ Untranslatable characters are set to � or ?. No transliteration is currently s
 
 ## TODO
 
-*   Support streaming character conversion, something like util.pipe(req, iconv.fromEncodingStream('latin1')).
-*   Add more encodings.
-*   Add transliteration (best fit char).
-*   Add tests and correct support of variable-byte encodings (currently work is delegated to node).
+ * Support streaming character conversion, something like util.pipe(req, iconv.fromEncodingStream('latin1')).
+ * Add more encodings.
+ * Add transliteration (best fit char).
+ * Add tests and correct support of variable-byte encodings (currently work is delegated to node).
+
+## Adoption
+[![NPM](https://nodei.co/npm-dl/iconv-lite.png)](https://nodei.co/npm/iconv-lite/)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-iconv-lite.git