Skip to content

Commit bdebfb3

Browse files
readme
1 parent 459e950 commit bdebfb3

File tree

1 file changed

+79
-4
lines changed

1 file changed

+79
-4
lines changed

README.md

Lines changed: 79 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
Sorting code bricks for JavaScript.
55

6+
```js
7+
let fordjohnson = sort._fordjohnson( search.binarysearch ) ;
8+
```
9+
610
[![NPM license](http://img.shields.io/npm/l/aureooms-js-sort.svg?style=flat)](https://raw.githubusercontent.com/aureooms/js-sort/master/LICENSE)
711
[![NPM version](http://img.shields.io/npm/v/aureooms-js-sort.svg?style=flat)](https://www.npmjs.org/package/aureooms-js-sort)
812
[![Bower version](http://img.shields.io/bower/v/aureooms-js-sort.svg?style=flat)](http://bower.io/search/?q=aureooms-js-sort)
@@ -15,16 +19,87 @@ Sorting code bricks for JavaScript.
1519
[![GitHub issues](http://img.shields.io/github/issues/aureooms/js-sort.svg?style=flat)](https://github.com/aureooms/js-sort/issues)
1620
[![Inline docs](http://inch-ci.org/github/aureooms/js-sort.svg?branch=master&style=shields)](http://inch-ci.org/github/aureooms/js-sort)
1721

18-
Can be managed through [duo](https://github.com/duojs/duo),
22+
23+
Can be managed through [jspm](https://github.com/jspm/jspm-cli),
24+
[duo](https://github.com/duojs/duo),
1925
[component](https://github.com/componentjs/component),
20-
[bower](https://github.com/bower/bower), or
21-
[npm](https://github.com/npm/npm).
26+
[bower](https://github.com/bower/bower),
27+
[ender](https://github.com/ender-js/Ender),
28+
[jam](https://github.com/caolan/jam),
29+
[spm](https://github.com/spmjs/spm),
30+
and [npm](https://github.com/npm/npm).
31+
32+
## Install
33+
34+
### jspm
35+
```terminal
36+
jspm install github:aureooms/js-sort
37+
# or
38+
jspm install npm:aureooms-js-sort
39+
```
40+
### duo
41+
No install step needed for duo!
42+
43+
### component
44+
```terminal
45+
component install aureooms/js-sort
46+
```
2247

48+
### bower
49+
```terminal
50+
bower install aureooms-js-sort
51+
```
52+
53+
### ender
54+
```terminal
55+
ender add aureooms-js-sort
56+
```
57+
58+
### jam
59+
```terminal
60+
jam install aureooms-js-sort
61+
```
62+
63+
### spm
64+
```terminal
65+
spm install aureooms-js-sort --save
66+
```
67+
68+
### npm
69+
```terminal
70+
npm install aureooms-js-sort --save
71+
```
72+
73+
## Require
74+
### jspm
75+
```js
76+
let sort = require( "github:aureooms/js-sort" ) ;
77+
// or
78+
import sort from 'aureooms-js-sort' ;
79+
```
80+
### duo
81+
```js
82+
let sort = require( "aureooms/js-sort" ) ;
83+
```
84+
85+
### component, ender, spm, npm
2386
```js
2487
let sort = require( "aureooms-js-sort" ) ;
2588
```
2689

27-
## Subpackages
90+
### bower
91+
The script tag exposes the global variable `sort`.
92+
```html
93+
<script src="bower_components/aureooms-js-sort/js/dist/sort.min.js"></script>
94+
```
95+
Alternatively, you can use any tool mentioned [here](http://bower.io/docs/tools/).
96+
97+
### jam
98+
```js
99+
require( [ "aureooms-js-sort" ] , function ( sort ) { ... } ) ;
100+
```
101+
102+
## Children
28103

29104
This package has several children:
30105

0 commit comments

Comments
 (0)