Skip to content

Commit 17fc4b5

Browse files
update readme
1 parent 1b8dc3c commit 17fc4b5

File tree

2 files changed

+10
-89
lines changed

2 files changed

+10
-89
lines changed

README.md

Lines changed: 0 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -20,92 +20,3 @@ a / b === 3 / 10 ; // true
2020
[![NPM downloads per month](https://img.shields.io/npm/dm/@aureooms/js-rational.svg?style=flat)](https://www.npmjs.org/package/@aureooms/js-rational)
2121
[![GitHub issues](https://img.shields.io/github/issues/aureooms/js-rational.svg?style=flat)](https://github.com/aureooms/js-rational/issues)
2222
[![Documentation](https://aureooms.github.io/js-rational/badge.svg)](https://aureooms.github.io/js-rational/source.html)
23-
24-
Can be managed through [jspm](https://github.com/jspm/jspm-cli),
25-
[duo](https://github.com/duojs/duo),
26-
[component](https://github.com/componentjs/component),
27-
[bower](https://github.com/bower/bower),
28-
[ender](https://github.com/ender-js/Ender),
29-
[jam](https://github.com/caolan/jam),
30-
[spm](https://github.com/spmjs/spm),
31-
and [npm](https://github.com/npm/npm).
32-
33-
## Install
34-
35-
### jspm
36-
```terminal
37-
jspm install github:aureooms/js-rational
38-
# or
39-
jspm install npm:@aureooms/js-rational
40-
```
41-
### duo
42-
No install step needed for duo!
43-
44-
### component
45-
```terminal
46-
component install aureooms/js-rational
47-
```
48-
49-
### bower
50-
```terminal
51-
bower install @aureooms/js-rational
52-
```
53-
54-
### ender
55-
```terminal
56-
ender add @aureooms/js-rational
57-
```
58-
59-
### jam
60-
```terminal
61-
jam install @aureooms/js-rational
62-
```
63-
64-
### spm
65-
```terminal
66-
spm install @aureooms/js-rational --save
67-
```
68-
69-
### npm
70-
```terminal
71-
npm install @aureooms/js-rational --save
72-
```
73-
74-
## Require
75-
### jspm
76-
```js
77-
let rational = require( "github:aureooms/js-rational" ) ;
78-
// or
79-
import rational from '@aureooms/js-rational' ;
80-
```
81-
### duo
82-
```js
83-
let rational = require( "aureooms/js-rational" ) ;
84-
```
85-
86-
### component, ender, spm, npm
87-
```js
88-
let rational = require( "@aureooms/js-rational" ) ;
89-
```
90-
91-
### bower
92-
The script tag exposes the global variable `rational`.
93-
```html
94-
<script src="bower_components/@aureooms/js-rational/js/dist/rational.min.js"></script>
95-
```
96-
Alternatively, you can use any tool mentioned [here](http://bower.io/docs/tools/).
97-
98-
### jam
99-
```js
100-
require( [ "@aureooms/js-rational" ] , function ( rational ) { ... } ) ;
101-
```
102-
103-
## Use
104-
105-
```js
106-
let number = require( '@aureooms/js-number' ) ;
107-
let add = rational._add( number.mul , number.add ) ;
108-
let sub = rational._sub( number.mul , number.sub ) ;
109-
let mul = rational._mul( number.mul ) ;
110-
let div = rational._div( number.mul ) ;
111-
```

doc/manual/example.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Example
2+
3+
```js
4+
import { _add , _sub , _mul , _div } from '@aureooms/js-rational' ;
5+
import * as integer from '@aureooms/js-integer' ;
6+
const add = _add( integer.mul , integer.add ) ;
7+
const sub = _sub( integer.mul , integer.sub ) ;
8+
const mul = _mul( integer.mul ) ;
9+
const div = _div( integer.mul ) ;
10+
```

0 commit comments

Comments
 (0)