Skip to content

Commit 3e06cbf

Browse files
committed
run verb to generate readme documentation
1 parent 676d874 commit 3e06cbf

File tree

2 files changed

+32
-27
lines changed

2 files changed

+32
-27
lines changed

.verb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ var one = {b: {c: {d: 'e'}}};
77
var two = {b: {c: {f: 'g', j: 'i'}}};
88
var three = {foo: 'bar'};
99

10-
assign(one, two, three);
10+
console.log(assign(one, two, three));
1111
//=> {b: {c: {d: 'e', f: 'g', j: 'i'}}, foo: 'bar'}
1212
```

README.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# assign-deep [![NPM version](https://img.shields.io/npm/v/assign-deep.svg?style=flat)](https://www.npmjs.com/package/assign-deep) [![NPM downloads](https://img.shields.io/npm/dm/assign-deep.svg?style=flat)](https://npmjs.org/package/assign-deep) [![Build Status](https://img.shields.io/travis/jonschlinkert/assign-deep.svg?style=flat)](https://travis-ci.org/jonschlinkert/assign-deep)
1+
# assign-deep [![NPM version](https://img.shields.io/npm/v/assign-deep.svg?style=flat)](https://www.npmjs.com/package/assign-deep) [![NPM monthly downloads](https://img.shields.io/npm/dm/assign-deep.svg?style=flat)](https://npmjs.org/package/assign-deep) [![NPM total downloads](https://img.shields.io/npm/dt/assign-deep.svg?style=flat)](https://npmjs.org/package/assign-deep) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/assign-deep.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/assign-deep)
22

33
> Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target (first) object.
44
@@ -7,7 +7,7 @@
77
Install with [npm](https://www.npmjs.com/):
88

99
```sh
10-
$ npm install assign-deep --save
10+
$ npm install --save assign-deep
1111
```
1212

1313
## Usage
@@ -19,57 +19,62 @@ var one = {b: {c: {d: 'e'}}};
1919
var two = {b: {c: {f: 'g', j: 'i'}}};
2020
var three = {foo: 'bar'};
2121

22-
assign(one, two, three);
22+
console.log(assign(one, two, three));
2323
//=> {b: {c: {d: 'e', f: 'g', j: 'i'}}, foo: 'bar'}
2424
```
2525

26-
## Related projects
26+
## About
27+
28+
### Related projects
2729

2830
You might also be interested in these projects:
2931

30-
* [assign-symbols](https://www.npmjs.com/package/assign-symbols): Assign the enumerable es6 Symbol properties from an object (or objects) to the first object… [more](https://www.npmjs.com/package/assign-symbols) | [homepage](https://github.com/jonschlinkert/assign-symbols)
31-
* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow)
32-
* [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep)
33-
* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep)
32+
* [assign-symbols](https://www.npmjs.com/package/assign-symbols): Assign the enumerable es6 Symbol properties from an object (or objects) to the first object… [more](https://github.com/jonschlinkert/assign-symbols) | [homepage](https://github.com/jonschlinkert/assign-symbols "Assign the enumerable es6 Symbol properties from an object (or objects) to the first object passed on the arguments. Can be used as a supplement to other extend, assign or merge methods as a polyfill for the Symbols part of the es6 Object.assign method.")
33+
* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow "Extend an object with the properties of additional objects. node.js/javascript util.")
34+
* [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep "Recursively merge values in a javascript object.")
35+
* [mixin-deep](https://www.npmjs.com/package/mixin-deep): Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone. | [homepage](https://github.com/jonschlinkert/mixin-deep "Deeply mix the properties of objects into the first object. Like merge-deep, but doesn't clone.")
3436

35-
## Contributing
37+
### Contributing
3638

37-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/assign-deep/issues/new).
39+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
3840

39-
## Building docs
41+
### Contributors
4042

41-
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
43+
| **Commits** | **Contributor** |
44+
| --- | --- |
45+
| 23 | [jonschlinkert](https://github.com/jonschlinkert) |
46+
| 11 | [doowb](https://github.com/doowb) |
4247

43-
```sh
44-
$ npm install verb && npm run docs
45-
```
48+
### Building docs
49+
50+
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
4651

47-
Or, if [verb](https://github.com/verbose/verb) is installed globally:
52+
To generate the readme, run the following command:
4853

4954
```sh
50-
$ verb
55+
$ npm install -g verbose/verb#dev verb-generate-readme && verb
5156
```
5257

53-
## Running tests
58+
### Running tests
5459

55-
Install dev dependencies:
60+
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
5661

5762
```sh
58-
$ npm install -d && npm test
63+
$ npm install && npm test
5964
```
6065

61-
## Author
66+
### Author
6267

6368
**Jon Schlinkert**
6469

6570
* [github/jonschlinkert](https://github.com/jonschlinkert)
66-
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
71+
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
6772

68-
## License
73+
### License
6974

70-
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
71-
Released under the [MIT license](https://github.com/jonschlinkert/assign-deep/blob/master/LICENSE).
75+
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
76+
Released under the [MIT License](LICENSE).
7277

7378
***
7479

75-
_This file was generated by [base-app](https://github.com/node-base/base-app), v0.1.0, on April 04, 2016._
80+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on August 03, 2017._

0 commit comments

Comments
 (0)