From e5432204b24b9ef4fc4aaab5c2b00461dfbb8491 Mon Sep 17 00:00:00 2001 From: Yanick Champoux Date: Wed, 28 Mar 2018 10:43:20 -0400 Subject: [PATCH] Mention the available dash docset version of the documentation (#76) * mention the docset * accepted as part of the official user-contribs --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6518933..ee77597 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ supports [partial application][currying], so the parameter order is: ## API and Examples ### Full example + ```js var u = require('updeep'); @@ -174,6 +175,7 @@ expect(result).to.eql({ todos: [{ done: false }, { done: false }, { done: false ``` #### When null or undefined object, updeep uses a default object + ```javascript var result = u({ foo: 'bar' }, null); expect(result).to.eql({ foo: 'bar' }); @@ -525,21 +527,33 @@ case. ```bash $ npm version major|minor|patch ``` + 1. Update the `CHANGELOG.md`. 1. Add the new version and corresponding notes. 1. Add a link to the new version. 1. Update the `unreleased` link compare to be based off of the new version. 1. Publish and push: - ```bash - $ npm publish - $ git push origin master --follow-tags - ``` +```bash +$ npm publish +$ git push origin master --follow-tags +``` + +## See Also + +A [Dash][dash] version of the documention is also available +as part of their user-contributed docsets. +For [Zeal][zeal] users, the user-contributed docsets +can be accessed via [zealusercontributions.herokuapp.com][zealuc]. ## License MIT ©2015 [Substantial](http://substantial.com) +[zealuc]: http://zealusercontributions.herokuapp.com/ +[dash]: https://kapeli.com/dash +[zeal]: https://zealdocs.org/ +[docset]: https://github.com/yanick/dash-docset-updeep [npm-image]: https://badge.fury.io/js/updeep.svg [npm-url]: https://npmjs.org/package/updeep [travis-image]: https://travis-ci.org/substantial/updeep.svg?branch=master