|
1 |
| -# array-sort [](https://www.npmjs.com/package/array-sort) [](https://npmjs.org/package/array-sort) [](https://travis-ci.org/jonschlinkert/array-sort) |
| 1 | +# array-sort [](https://www.npmjs.com/package/array-sort) [](https://npmjs.org/package/array-sort) [](https://npmjs.org/package/array-sort) [](https://travis-ci.org/jonschlinkert/array-sort) [](https://ci.appveyor.com/project/jonschlinkert/array-sort) |
2 | 2 |
|
3 | 3 | > 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.
|
4 | 4 |
|
|
7 | 7 | Install with [npm](https://www.npmjs.com/):
|
8 | 8 |
|
9 | 9 | ```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 |
11 | 17 | ```
|
12 | 18 |
|
13 | 19 | ## Usage
|
@@ -139,54 +145,57 @@ console.log(result);
|
139 | 145 | // { foo: 'x', bar: 'y', baz: 'z' } ]
|
140 | 146 | ```
|
141 | 147 |
|
142 |
| -## Related projects |
| 148 | +## About |
143 | 149 |
|
144 |
| -You might also be interested in these projects: |
| 150 | +### Related projects |
145 | 151 |
|
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.") |
151 | 157 |
|
152 |
| -## Contributing |
| 158 | +### Contributing |
153 | 159 |
|
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). |
155 | 161 |
|
156 |
| -## Building docs |
| 162 | +### Contributors |
157 | 163 |
|
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) | |
159 | 168 |
|
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.)_ |
163 | 172 |
|
164 |
| -Or, if [verb](https://github.com/verbose/verb) is installed globally: |
| 173 | +To generate the readme, run the following command: |
165 | 174 |
|
166 | 175 | ```sh
|
167 |
| -$ verb |
| 176 | +$ npm install -g verbose/verb#dev verb-generate-readme && verb |
168 | 177 | ```
|
169 | 178 |
|
170 |
| -## Running tests |
| 179 | +### Running tests |
171 | 180 |
|
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: |
173 | 182 |
|
174 | 183 | ```sh
|
175 |
| -$ npm install -d && npm test |
| 184 | +$ npm install && npm test |
176 | 185 | ```
|
177 | 186 |
|
178 |
| -## Author |
| 187 | +### Author |
179 | 188 |
|
180 | 189 | **Jon Schlinkert**
|
181 | 190 |
|
182 | 191 | * [github/jonschlinkert](https://github.com/jonschlinkert)
|
183 |
| -* [twitter/jonschlinkert](http://twitter.com/jonschlinkert) |
| 192 | +* [twitter/jonschlinkert](https://twitter.com/jonschlinkert) |
184 | 193 |
|
185 |
| -## License |
| 194 | +### License |
186 | 195 |
|
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). |
189 | 198 |
|
190 | 199 | ***
|
191 | 200 |
|
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