Mention the available dash docset version of the documentation (#76)
* mention the docset * accepted as part of the official user-contribs
This commit is contained in:
parent
1387c7d1f7
commit
e5432204b2
14
README.md
14
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,6 +527,7 @@ 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.
|
||||
@ -536,10 +539,21 @@ case.
|
||||
$ 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
|
||||
|
Loading…
Reference in New Issue
Block a user