diff options
author | Rob Loach <robloach@gmail.com> | 2015-01-04 09:34:40 -0500 |
---|---|---|
committer | Rob Loach <robloach@gmail.com> | 2015-01-04 09:34:40 -0500 |
commit | 86b17cfcd606efa39ada8645108ab9d339b46479 (patch) | |
tree | 948b539b8fb17d2c5d6b8d2d1254228e35af8938 | |
parent | 977005a6fac110aa47fb9c323294619d48010af0 (diff) | |
download | jquery-once-86b17cfcd606efa39ada8645108ab9d339b46479.zip jquery-once-86b17cfcd606efa39ada8645108ab9d339b46479.tar.gz jquery-once-86b17cfcd606efa39ada8645108ab9d339b46479.tar.bz2 |
Update documentation
-rw-r--r-- | HISTORY.md | 6 | ||||
-rw-r--r-- | README.md | 15 | ||||
-rw-r--r-- | package.json | 2 |
3 files changed, 14 insertions, 9 deletions
@@ -2,7 +2,11 @@ ## v2.0.x - Added [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown) to - automatically generate API documentation + automatically build API documentation +- Added type checking of the id argument across all jQuery Once functions + - From [@theodoreb](http://github.com/theodoreb) +- Fixed inline code documentation + - From [@yched](http://github.com/yched) ## v2.0.0-beta.2 December 31, 2014 - Update documentation @@ -67,8 +67,8 @@ Install dependencies through [npm](http://npmjs.org): npm install -Use [Mocha](http://mochajs.org) to test with [ESLint](http://eslint.org) and -[Mocha JSDom](https://github.com/rstacruz/mocha-jsdom): +Test with [ESLint](http://eslint.org), [Mocha](http://mochajs.org) and [Mocha +JSDom](https://github.com/rstacruz/mocha-jsdom): npm test @@ -78,14 +78,15 @@ and [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown): npm run projectz npm run docs -Build the project with: +Build `jquery.once.min.js` with: - npm run release + npm run build -Tag and publish the new versions to [npm](http://npmjs.com): +Tag and publish the new versions to [npm](http://npmjs.com) with [Semantic +Versioning](http://semver.org/): - git tag 2.4.0 - git push origin 2.4.0 + git tag 2.0.0-alpha.3 + git push origin 2.0.0-alpha.3 npm publish diff --git a/package.json b/package.json index 123eda1..6990063 100644 --- a/package.json +++ b/package.json @@ -63,6 +63,6 @@ "test": "./node_modules/.bin/mocha", "projectz": "./node_modules/.bin/projectz compile", "docs": "./node_modules/.bin/jsdoc2md jquery.once.js > API.md", - "release": "./node_modules/.bin/uglifyjs jquery.once.js -o jquery.once.min.js --comments --source-map jquery.once.min.js.map --mangle" + "build": "./node_modules/.bin/uglifyjs jquery.once.js -o jquery.once.min.js --comments --source-map jquery.once.min.js.map --mangle" } } |