add license

This commit is contained in:
Chen Yi-Cyuan
2014-01-05 12:51:08 +08:00
parent 5c752b5c34
commit e21d04f9cb
7 changed files with 78 additions and 29 deletions
+37 -25
View File
@@ -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:
var md5 = require('js-md5');
```JavaScript
md5 = require('js-md5');
```
And you could use like this:
md5('Message to hash');
```JavaScript
md5('Message to hash');
```
## Example
Code
md5('');
md5('The quick brown fox jumps over the lazy dog');
md5('The quick brown fox jumps over the lazy dog.');
```JavaScript
md5('');
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
md5('中文');
```JavaScript
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
jQuery.md5 = md5
```JavaScript
jQuery.md5 = md5
```
And then you could use like this:
$.md5('message');
```JavaScript
$.md5('message');
```
### Prototype
If you prefer prototype style, you can add following code to add a prototype extension.
Code
String.prototype.md5 = function() {
return md5(this);
};
```JavaScript
String.prototype.md5 = function() {
return md5(this);
};
```
And then you could use like this:
'message'.md5();
```JavaScript
'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