shorthash - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

@@ -8,3 +8,3 @@ {
     "name": "shorthash",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "description": "Node.js module to get a short unique hash of a string",
@@ -11,0 +11,0 @@ "preferGlobal": "true",

README.md

@@ -1,4 +0,28 @@
-node-shorthash
-==============
+# shorthash
 
-get an unique short hash of a string
++ A mini Node.js module to generate short, alpha-number, undecryptable and unique hash id from a long string (utf8 format).
++ Use shorthash when you want to encrypt a string like a movie name or a people name to a short, unique and url friendly id.
++ so with shorthash, you can build an id-string map, instead of quering the id from db each time, you just calculate the id out on the fly. 
++ it's quite convenient in many conditions if you want to build a site like [书本画](http://shubenhua.com), a book search engine in China.
+
+
+## Usage
+
+#### less's more, no options, just unique the string. 
+
+```javascript
+var sh = require("shorthash");
+
+console.log(sh.unique('[e-mail]'));
+// you will get: Z1bL2tE
+
+console.log(sh.unique('my name is really big big and big...'));
+// you will get: Z1TirWS
+
+console.log(sh.unique('万里长城永不倒。。。'));
+// you will get: 2r6EFF
+
+console.log(sh.unique('和平'));
+// you will get: 33NM
+
+```

No alert changes

Improved metrics

Total package byte prevSize

8980

increased by11.1%

Number of lines in readme file

28

increased by600%

No dependency changes