add license

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.1.1 / 2014-01-05
+
+Update license
+
 # v0.1.0 / 2014-01-04
 
 Initial release

LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2014 emn178@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -8,60 +8,72 @@ For node.js, you can use this command to install:
 
 ## Usage
 If you use node.js, you should require the module first:
-
+```JavaScript
-    var md5 = require('js-md5');
+md5 = require('js-md5');
-
+```
 And you could use like this:
-
+```JavaScript
-    md5('Message to hash');
+md5('Message to hash');
-
+```
 ## Example
 Code
-
+```JavaScript
-    md5('');
+md5('');
-    md5('The quick brown fox jumps over the lazy dog');
+md5('The quick brown fox jumps over the lazy dog');
-    md5('The quick brown fox jumps over the lazy dog.');
+md5('The quick brown fox jumps over the lazy dog.');
+```
 Output
 
     d41d8cd98f00b204e9800998ecf8427e
     9e107d9d372bb6826bd81d3542a419d6
     e4d909c290d0fb1ca068ffaddf22cbd0
 
-It also support UTF-8 encoding:
+It also supports UTF-8 encoding:
 
 Code
-
+```JavaScript
-    md5('中文');
+md5('中文');
+```
 Output
 
     a7bac2239fcdcb3a067903d8077c4a07
 
 ## Tests
-You can open `tests/index.html` in browser or use node.js to run `node tests/node-test.js` for test.
+You can open `tests/index.html` in browser or use node.js to run test
 
-You also could use `npm test` instance of `node tests/node-test.js`.
+    node tests/node-test.js
+
+or
+
+    npm test
 
 ## Extensions
 ### jQuery
 If you prefer jQuery style, you can add following code to add a jQuery extension.
 
 Code
-
+```JavaScript
-    jQuery.md5 = md5
+jQuery.md5 = md5
+```
 And then you could use like this:
-
+```JavaScript
-    $.md5('message');
+$.md5('message');
+```
 ### Prototype
 If you prefer prototype style, you can add following code to add a prototype extension.
 
 Code
-
+```JavaScript
-    String.prototype.md5 = function() {
+String.prototype.md5 = function() {
-      return md5(this);
+  return md5(this);
-    };
+};
+```
 And then you could use like this:
-
+```JavaScript
-    'message'.md5();
+'message'.md5();
+```
+## License
+The project is released under the [MIT license](http://www.opensource.org/licenses/MIT).
 
 ## Contact
 The project's website is located at https://github.com/emn178/js-md5  

package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-md5",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A simple MD5 hash function for JavaScript supports UTF-8 encoding.",
   "main": "src/md5.js",
   "scripts": {
@@ -13,8 +13,11 @@
   "keywords": [
     "md5",
     "hash",
-    "encryption"
+    "encryption",
+    "cryptography",
+    "HMAC"
   ],
+  "license": "MIT",
   "author": "emn178 <emn178@gmail.com>",
   "homepage": "https://github.com/emn178/js-md5",
   "bugs": {

src/md5.js

@@ -1,3 +1,13 @@
+/*
+ * js-md5 v0.1.1
+ * https://github.com/emn178/js-md5
+ *
+ * Copyright 2014, emn178@gmail.com
+ *
+ * Licensed under the MIT license:
+ * http://www.opensource.org/licenses/MIT
+ */
+
 (function(root, undefined){
   'use strict';
 

tests/debug.js

@@ -1,4 +1,4 @@
-(function(root){
+(function(root) {
   var assert = function (title, expect, actual) {
     if(expect == actual)
       console.log(title + ': true');

tests/node-test.js

@@ -1,3 +1,3 @@
-global.md5 = require('../src/md5.js');
+md5 = require('../src/md5.js');
 require('./debug.js');
 require('./test.js');