add license

pull/3/head
Chen Yi-Cyuan 12 years ago
parent 5c752b5c34
commit e21d04f9cb

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

@ -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.

@ -8,60 +8,72 @@ For node.js, you can use this command to install:
## Usage ## Usage
If you use node.js, you should require the module first: 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: And you could use like this:
```JavaScript
md5('Message to hash'); md5('Message to hash');
```
## Example ## Example
Code 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 Output
d41d8cd98f00b204e9800998ecf8427e d41d8cd98f00b204e9800998ecf8427e
9e107d9d372bb6826bd81d3542a419d6 9e107d9d372bb6826bd81d3542a419d6
e4d909c290d0fb1ca068ffaddf22cbd0 e4d909c290d0fb1ca068ffaddf22cbd0
It also support UTF-8 encoding: It also supports UTF-8 encoding:
Code Code
```JavaScript
md5('中文'); md5('中文');
```
Output Output
a7bac2239fcdcb3a067903d8077c4a07 a7bac2239fcdcb3a067903d8077c4a07
## Tests ## 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 ## Extensions
### jQuery ### jQuery
If you prefer jQuery style, you can add following code to add a jQuery extension. If you prefer jQuery style, you can add following code to add a jQuery extension.
Code Code
```JavaScript
jQuery.md5 = md5 jQuery.md5 = md5
```
And then you could use like this: And then you could use like this:
```JavaScript
$.md5('message'); $.md5('message');
```
### Prototype ### Prototype
If you prefer prototype style, you can add following code to add a prototype extension. If you prefer prototype style, you can add following code to add a prototype extension.
Code Code
```JavaScript
String.prototype.md5 = function() { String.prototype.md5 = function() {
return md5(this); return md5(this);
}; };
```
And then you could use like 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 ## Contact
The project's website is located at https://github.com/emn178/js-md5 The project's website is located at https://github.com/emn178/js-md5

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

@ -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){ (function(root, undefined){
'use strict'; 'use strict';

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

Loading…
Cancel
Save