Skip to content

Commit 776fc21

Browse files
committed
run verb to generate readme
1 parent 53d8d0c commit 776fc21

File tree

1 file changed

+36
-27
lines changed

1 file changed

+36
-27
lines changed

README.md

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

33
> Fast and powerful array sorting. Sort an array of objects by one or more properties. Any number of nested properties or custom comparison functions may be used.
44
@@ -7,7 +7,13 @@
77
Install with [npm](https://www.npmjs.com/):
88

99
```sh
10-
$ npm install array-sort --save
10+
$ npm install --save array-sort
11+
```
12+
13+
Install with [yarn](https://yarnpkg.com):
14+
15+
```sh
16+
$ yarn add array-sort
1117
```
1218

1319
## Usage
@@ -139,54 +145,57 @@ console.log(result);
139145
// { foo: 'x', bar: 'y', baz: 'z' } ]
140146
```
141147

142-
## Related projects
148+
## About
143149

144-
You might also be interested in these projects:
150+
### Related projects
145151

146-
* [get-value](https://www.npmjs.com/package/get-value): Use property paths (`a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value)
147-
* [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value)
148-
* [sort-asc](https://www.npmjs.com/package/sort-asc): Sort array elements in ascending order. | [homepage](https://github.com/jonschlinkert/sort-asc)
149-
* [sort-desc](https://www.npmjs.com/package/sort-desc): Sort array elements in descending order. | [homepage](https://github.com/jonschlinkert/sort-desc)
150-
* [sort-object](https://www.npmjs.com/package/sort-object): Sort the keys in an object. | [homepage](https://github.com/doowb/sort-object)
152+
* [get-value](https://www.npmjs.com/package/get-value): Use property paths (`a.b.c`) to get a nested value from an object. | [homepage](https://github.com/jonschlinkert/get-value "Use property paths (`a.b.c`) to get a nested value from an object.")
153+
* [set-value](https://www.npmjs.com/package/set-value): Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths. | [homepage](https://github.com/jonschlinkert/set-value "Create nested values and any intermediaries using dot notation (`'a.b.c'`) paths.")
154+
* [sort-asc](https://www.npmjs.com/package/sort-asc): Sort array elements in ascending order. | [homepage](https://github.com/jonschlinkert/sort-asc "Sort array elements in ascending order.")
155+
* [sort-desc](https://www.npmjs.com/package/sort-desc): Sort array elements in descending order. | [homepage](https://github.com/jonschlinkert/sort-desc "Sort array elements in descending order.")
156+
* [sort-object](https://www.npmjs.com/package/sort-object): Sort the keys in an object. | [homepage](https://github.com/doowb/sort-object "Sort the keys in an object.")
151157

152-
## Contributing
158+
### Contributing
153159

154-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/array-sort/issues/new).
160+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
155161

156-
## Building docs
162+
### Contributors
157163

158-
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
164+
| **Commits** | **Contributor** |
165+
| --- | --- |
166+
| 10 | [jonschlinkert](https://github.com/jonschlinkert) |
167+
| 1 | [wkevina](https://github.com/wkevina) |
159168

160-
```sh
161-
$ npm install verb && npm run docs
162-
```
169+
### Building docs
170+
171+
_(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.)_
163172

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

166175
```sh
167-
$ verb
176+
$ npm install -g verbose/verb#dev verb-generate-readme && verb
168177
```
169178

170-
## Running tests
179+
### Running tests
171180

172-
Install dev dependencies:
181+
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:
173182

174183
```sh
175-
$ npm install -d && npm test
184+
$ npm install && npm test
176185
```
177186

178-
## Author
187+
### Author
179188

180189
**Jon Schlinkert**
181190

182191
* [github/jonschlinkert](https://github.com/jonschlinkert)
183-
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
192+
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
184193

185-
## License
194+
### License
186195

187-
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
188-
Released under the [MIT license](https://github.com/jonschlinkert/array-sort/blob/master/LICENSE).
196+
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
197+
Released under the [MIT License](LICENSE).
189198

190199
***
191200

192-
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 21, 2016._
201+
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 24, 2017._

0 commit comments

Comments
 (0)