diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c2658d7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules/ diff --git a/README.md b/README.md index 4c2495e..ca920ee 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ -node-shorthash -============== +# shorthash -get an unique short hash of a string \ No newline at end of file +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 books search engine in China. + + +## Usage + +#### less's more, no options, just unique the string. + +```javascript + +var sh = require("shorthash"); + +console.log(sh.unique('foobar@example.com')); +// 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 newline at end of file