From 8b60638f50f241669157c34da14895f0005b6603 Mon Sep 17 00:00:00 2001 From: Chen Yi-Cyuan Date: Sun, 5 Jan 2014 12:58:01 +0800 Subject: [PATCH] add license --- CHANGELOG.md | 4 +++ LICENSE.txt | 20 +++++++++++++++ README.md | 62 +++++++++++++++++++++++++++------------------- package.json | 9 ++++--- src/sha1.js | 10 ++++++++ tests/node-test.js | 2 +- 6 files changed, 78 insertions(+), 29 deletions(-) create mode 100644 LICENSE.txt diff --git a/CHANGELOG.md b/CHANGELOG.md index a6d5b64..a003cf0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +# v0.1.1 / 2014-01-05 + +Update license + # v0.1.0 / 2014-01-04 Initial release diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..dff2ebd --- /dev/null +++ b/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. diff --git a/README.md b/README.md index 75c737c..4718a2b 100644 --- a/README.md +++ b/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: - - var sha1 = require('js-sha1'); - +```JavaScript +sha1 = require('js-sha1'); +``` And you could use like this: - - sha1('Message to hash'); - +```JavaScript +sha1('Message to hash'); +``` ## Example Code - - sha1(''); - sha1('The quick brown fox jumps over the lazy dog'); - sha1('The quick brown fox jumps over the lazy dog.'); +```JavaScript +sha1(''); +sha1('The quick brown fox jumps over the lazy dog'); +sha1('The quick brown fox jumps over the lazy dog.'); +``` Output da39a3ee5e6b4b0d3255bfef95601890afd80709 2fd4e1c67a2d28fced849ee1bb76e7391b93eb12 408d94384216f890ff7a0c3528e8bed1e0b01621 -It also support UTF-8 encoding: +It also supports UTF-8 encoding: Code - - sha1('中文'); +```JavaScript +sha1('中文'); +``` Output 7be2d2d20c106eee0836c9bc2b939890a78e8fb3 ## 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.sha1 = sha1 +```JavaScript +jQuery.sha1 = sha1 +``` And then you could use like this: - - $.sha1('message'); +```JavaScript +$.sha1('message'); +``` ### Prototype If you prefer prototype style, you can add following code to add a prototype extension. Code - - String.prototype.sha1 = function() { - return sha1(this); - }; +```JavaScript +String.prototype.sha1 = function() { + return sha1(this); +}; +``` And then you could use like this: - - 'message'.sha1(); +```JavaScript +'message'.sha1(); +``` +## 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-sha1 diff --git a/package.json b/package.json index c076bc7..53b2f8b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "js-sha1", - "version": "0.1.0", + "version": "0.1.1", "description": "A simple SHA1 hash function for JavaScript supports UTF-8 encoding.", "main": "src/sha1.js", "scripts": { @@ -11,10 +11,13 @@ "url": "https://github.com/emn178/js-sha1.git" }, "keywords": [ + "sha", "sha1", - "hash", - "encryption" + "encryption", + "cryptography", + "HMAC" ], + "license": "MIT", "author": "emn178 ", "homepage": "https://github.com/emn178/js-sha1", "bugs": { diff --git a/src/sha1.js b/src/sha1.js index da09f4f..72f18ca 100644 --- a/src/sha1.js +++ b/src/sha1.js @@ -1,3 +1,13 @@ +/* + * js-sha1 v0.1.1 + * https://github.com/emn178/js-sha1 + * + * Copyright 2014, emn178@gmail.com + * + * Licensed under the MIT license: + * http://www.opensource.org/licenses/MIT + */ + (function(root, undefined){ 'use strict'; diff --git a/tests/node-test.js b/tests/node-test.js index a57177a..0281d8b 100644 --- a/tests/node-test.js +++ b/tests/node-test.js @@ -1,3 +1,3 @@ -global.sha1 = require('../src/sha1.js'); +sha1 = require('../src/sha1.js'); require('./debug.js'); require('./test.js');