summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwesbos <wesbos@gmail.com>2013-08-23 11:37:11 -0400
committerwesbos <wesbos@gmail.com>2013-08-23 11:37:11 -0400
commit72e02e1c9c4ce41332c50f85fcdc3c420712df46 (patch)
treeec1e6a5428776b4086a0579674f894434469b585
parent415356d07da4148735ec98f9bd41324effe65653 (diff)
downloadjsSHA-72e02e1c9c4ce41332c50f85fcdc3c420712df46.zip
jsSHA-72e02e1c9c4ce41332c50f85fcdc3c420712df46.tar.gz
jsSHA-72e02e1c9c4ce41332c50f85fcdc3c420712df46.tar.bz2
Improved docs
-rwxr-xr-xREADME.md (renamed from README)27
1 files changed, 18 insertions, 9 deletions
diff --git a/README b/README.md
index 4d780b8..d6e8fa5 100755
--- a/README
+++ b/README.md
@@ -1,4 +1,5 @@
-jsSHA - A JavaScript implementation of the complete Secure Hash Standard family
+# jsSHA
+A JavaScript implementation of the complete Secure Hash Standard family
(SHA-1, SHA-224, SHA-256, SHA-384, and SHA-512) as well as HMAC by
Brian Turek
@@ -7,6 +8,7 @@ About
jsSHA is a javaScript implementation of the complete Secure Hash Algorithm
family as defined by FIPS PUB 180-2
(http://csrc.nist.gov/publications/fips/fips180-2/fips180-2withchangenotice.pdf).
+
It also includes the HMAC algorithm with SHA support as defined by FIPS PUB 198-1
(http://csrc.nist.gov/publications/fips/fips198-1/FIPS-198-1_final.pdf)
@@ -20,29 +22,36 @@ on 25 February 2004 so it was also included in this package.
Files
-------------------------
-src/sha_dev.js
+**src/sha_dev.js**
+
A commented implementation of the entire SHA family of hashes. Not to be used
in production.
-src/sha.js
+**src/sha.js**
+
A Google Closure Compiler optimized version of the entire library
-src/sha1.js
+**src/sha1.js**
+
A Google Closure Compiler optimized version the library with non SHA-1
functionality removed
-src/sha256.js
+**src/sha256.js**
+
A Google Closure Compiler optimized version the library with non SHA-224/SHA-256
functionality removed
-src/sha512.js
+**src/sha512.js**
+
A Google Closure Compiler optimized version the library with non SHA-384/SHA-512
functionality removed
-test/test.html
+**test/test.html**
+
A test page that calculates various hashes and has their correct values
-build/make-release
+**build/make-release**
+
A Bash script that runs the various Google Closure Compiler commands to build
a release
@@ -90,4 +99,4 @@ where <FLAG> is a bitwise OR of the following values:
Contact Info
-------------------------
-The project's website is located at http://caligatio.github.com/jsSHA/
+The project's website is located at [http://caligatio.github.com/jsSHA/](http://caligatio.github.com/jsSHA/)