[Pkg-javascript-commits] [node-sha.js] 40/237: readme

[Bastien Roucariès]

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

rouca pushed a commit to branch master
in repository node-sha.js.

commit 6a9992a77747286d059f0335d5358a013cd0096b
Author: Dominic Tarr <dominic.tarr at gmail.com>
Date:   Fri Dec 27 14:56:23 2013 +0700

    readme
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 0b41b54..9f523cb 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,29 @@
 # sha.js
 
+Streamable SHA1 hash in pure javascript.
+
+[![build status](https://secure.travis-ci.org/dominictarr/sha.js.png)](http://travis-ci.org/dominictarr/sha.js)
+[![testling badge](https://ci.testling.com/dominictarr/sha.js.png)](https://ci.testling.com/dominictarr/sha.js)
+
+## Example
+
+``` js
+var Sha1 = require('sha.js')
+var h = new Sha1().update('abc', 'utf8').digest('hex')
+console.log(h) //a9993e364706816aba3e25717850c26c9cd0d89d
+```
+
+## Note
+
+Note, this doesn't actually implement a stream, but wrapping this in a stream is trivial.
+but is does update incrementally, so you can hash things larger than ram, and also, since it reuses
+the typedarrays, it uses a constant amount of memory (except when using base64 or utf8 encoding,
+see code comments)
+
+## Acknowledgements
+
+This work is derived from Paul Johnston's ["A JavaScript implementation of the Secure Hash Algorithm"]
+(http://pajhome.org.uk/crypt/md5/sha1.html)
 
 ## License
 

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