yanick/updeep-remeda
1
0
Fork 0
Code Issues 2 Pull Requests Projects Releases Wiki Activity

Mention the available dash docset version of the documentation (#76)

Browse Source 
* mention the docset

* accepted as part of the official user-contribs
This commit is contained in:
Yanick Champoux 2018-03-28 10:43:20 -04:00 committed by Aaron Jensen
parent 1387c7d1f7
commit e5432204b2
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -35,6 +35,7 @@ supports [partial application][currying], so the parameter order is:
## API and Examples ## API and Examples
### Full example ### Full example
```js ```js
var u = require('updeep'); 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 #### When null or undefined object, updeep uses a default object
```javascript ```javascript
var result = u({ foo: 'bar' }, null); var result = u({ foo: 'bar' }, null);
expect(result).to.eql({ foo: 'bar' }); expect(result).to.eql({ foo: 'bar' });
@ -525,21 +527,33 @@ case.
```bash ```bash
$ npm version major|minor|patch $ npm version major|minor|patch
``` ```
1. Update the `CHANGELOG.md`. 1. Update the `CHANGELOG.md`.
1. Add the new version and corresponding notes. 1. Add the new version and corresponding notes.
1. Add a link to the new version. 1. Add a link to the new version.
1. Update the `unreleased` link compare to be based off of the new version. 1. Update the `unreleased` link compare to be based off of the new version.
1. Publish and push: 1. Publish and push:
```bash ```bash
$ npm publish $ npm publish
$ git push origin master --follow-tags $ 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 ## License
MIT ©2015 [Substantial](http://substantial.com) 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-image]: https://badge.fury.io/js/updeep.svg
[npm-url]: https://npmjs.org/package/updeep [npm-url]: https://npmjs.org/package/updeep
[travis-image]: https://travis-ci.org/substantial/updeep.svg?branch=master [travis-image]: https://travis-ci.org/substantial/updeep.svg?branch=master