Skip to content

Commit 2ecd779

Browse files
fix doc
1 parent 53ed015 commit 2ecd779

File tree

2 files changed

+6
-88
lines changed

2 files changed

+6
-88
lines changed

README.md

Lines changed: 1 addition & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[js-collections](http://aureooms.github.io/js-collections)
22
==
33

4-
Collections code bricks for JavaScript. Parent is
4+
Collections library for JavaScript. Parent is
55
[js-data-structures](https://github.com/aureooms/js-data-structures).
66

77
JavaScript version of
@@ -32,93 +32,6 @@ let {
3232
[![GitHub issues](http://img.shields.io/github/issues/aureooms/js-collections.svg?style=flat)](https://github.com/aureooms/js-collections/issues)
3333
[![Documentation](https://aureooms.github.io/js-collections/badge.svg)](https://aureooms.github.io/js-collections/source.html)
3434

35-
Can be managed through [jspm](https://github.com/jspm/jspm-cli),
36-
[duo](https://github.com/duojs/duo),
37-
[component](https://github.com/componentjs/component),
38-
[bower](https://github.com/bower/bower),
39-
[ender](https://github.com/ender-js/Ender),
40-
[jam](https://github.com/caolan/jam),
41-
[spm](https://github.com/spmjs/spm),
42-
and [npm](https://github.com/npm/npm).
43-
44-
## Install
45-
46-
### jspm
47-
```terminal
48-
jspm install github:aureooms/js-collections
49-
# or
50-
jspm install npm:aureooms-js-collections
51-
```
52-
### duo
53-
No install step needed for duo!
54-
55-
### component
56-
```terminal
57-
component install aureooms/js-collections
58-
```
59-
60-
### bower
61-
```terminal
62-
bower install aureooms-js-collections
63-
```
64-
65-
### ender
66-
```terminal
67-
ender add aureooms-js-collections
68-
```
69-
70-
### jam
71-
```terminal
72-
jam install aureooms-js-collections
73-
```
74-
75-
### spm
76-
```terminal
77-
spm install aureooms-js-collections --save
78-
```
79-
80-
### npm
81-
```terminal
82-
npm install aureooms-js-collections --save
83-
```
84-
85-
## Require
86-
### jspm
87-
```js
88-
let collections = require( "github:aureooms/js-collections" ) ;
89-
// or
90-
import collections from 'aureooms-js-collections' ;
91-
```
92-
### duo
93-
```js
94-
let collections = require( "aureooms/js-collections" ) ;
95-
```
96-
97-
### component, ender, spm, npm
98-
```js
99-
let collections = require( "aureooms-js-collections" ) ;
100-
```
101-
102-
### bower
103-
The script tag exposes the global variable `collections`.
104-
```html
105-
<script src="bower_components/aureooms-js-collections/js/dist/collections.min.js"></script>
106-
```
107-
Alternatively, you can use any tool mentioned [here](http://bower.io/docs/tools/).
108-
109-
### jam
110-
```js
111-
require( [ "aureooms-js-collections" ] , function ( collections ) { ... } ) ;
112-
```
113-
114-
## Use
115-
116-
See Python's docs:
117-
118-
- [collections](https://docs.python.org/3.6/library/collections.html)
119-
- [heapq](https://docs.python.org/3.6/library/heapq.html)
120-
- [bisect](https://docs.python.org/3.6/library/bisect.html)
121-
12235
### Some changes w.r.t. Python's API
12336

12437
#### `heapq`

doc/manual/example.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
See Python's docs:
2+
3+
- [collections](https://docs.python.org/3.6/library/collections.html)
4+
- [heapq](https://docs.python.org/3.6/library/heapq.html)
5+
- [bisect](https://docs.python.org/3.6/library/bisect.html)

0 commit comments

Comments
 (0)