Skip to content

Commit

Permalink
up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
make-github-pseudonymous-again committed Jan 21, 2017
1 parent 9727a56 commit 7c47ab9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 96 deletions.
100 changes: 4 additions & 96 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
[js-array](http://aureooms.github.io/js-array)
[@aureooms/js-array](https://aureooms.github.io/js-array)
==

Array manipulation code bricks for JavaScript.
Array manipulation library for JavaScript.
See [documentation](https://aureooms.github.io/js-array).
Parent is [@aureooms/js-library](https://github.com/aureooms/js-library).

```js
let buffer = array.alloc( 10000 ) ;
Expand All @@ -17,97 +19,3 @@ let buffer = array.alloc( 10000 ) ;
[![NPM downloads per month](http://img.shields.io/npm/dm/aureooms-js-array.svg?style=flat)](https://www.npmjs.org/package/aureooms-js-array)
[![GitHub issues](http://img.shields.io/github/issues/aureooms/js-array.svg?style=flat)](https://github.com/aureooms/js-array/issues)
[![Documentation](https://aureooms.github.io/js-array/badge.svg)](https://aureooms.github.io/js-array/source.html)

Can be managed through [jspm](https://github.com/jspm/jspm-cli),
[duo](https://github.com/duojs/duo),
[component](https://github.com/componentjs/component),
[bower](https://github.com/bower/bower),
[ender](https://github.com/ender-js/Ender),
[jam](https://github.com/caolan/jam),
[spm](https://github.com/spmjs/spm),
and [npm](https://github.com/npm/npm).

## Install

### jspm
```terminal
jspm install github:aureooms/js-array
# or
jspm install npm:aureooms-js-array
```
### duo
No install step needed for duo!

### component
```terminal
component install aureooms/js-array
```

### bower
```terminal
bower install aureooms-js-array
```

### ender
```terminal
ender add aureooms-js-array
```

### jam
```terminal
jam install aureooms-js-array
```

### spm
```terminal
spm install aureooms-js-array --save
```

### npm
```terminal
npm install aureooms-js-array --save
```

## Require
### jspm
```js
let array = require( "github:aureooms/js-array" ) ;
// or
import array from 'aureooms-js-array' ;
```
### duo
```js
let array = require( "aureooms/js-array" ) ;
```

### component, ender, spm, npm
```js
let array = require( "aureooms-js-array" ) ;
```

### bower
The script tag exposes the global variable `array`.
```html
<script src="bower_components/aureooms-js-array/js/dist/array.min.js"></script>
```
Alternatively, you can use any tool mentioned [here](http://bower.io/docs/tools/).

### jam
```js
require( [ "aureooms-js-array" ] , function ( array ) { ... } ) ;
```

## Use

```js
let A = array.alloc( 10000 ) ;

array.iota( A , 0 , 10000 , 1 ) ;

let B = array.alloc( 20000 ) ;

array.copy( A , 0 , 10000 , B , 0 ) ;
array.copy( A , 0 , 10000 , B , 10000 ) ;

B ; // [ 0 , 1 , ... , 9999 , 0 , 1 , ... , 9999 ]
```
13 changes: 13 additions & 0 deletions doc/manual/example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

```js
let A = array.alloc( 10000 ) ;

array.iota( A , 0 , 10000 , 1 ) ;

let B = array.alloc( 20000 ) ;

array.copy( A , 0 , 10000 , B , 0 ) ;
array.copy( A , 0 , 10000 , B , 10000 ) ;

B ; // [ 0 , 1 , ... , 9999 , 0 , 1 , ... , 9999 ]
```

0 comments on commit 7c47ab9

Please sign in to comment.