Skip to content

Commit e593845

Browse files
committed
Add instructions for usage and development
1 parent 48dc77f commit e593845

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ A library for calculations with arbitrary length integers.
44
This is a simple wrapper around [BigInteger.js](https://github.com/peterolson/BigInteger.js)
55
by [Peter Olson](https://github.com/peterolson).
66

7+
8+
## Module documentation
9+
10+
- [Data.BigInt](docs/Data/BigInt.md)
11+
712
## Example
813

914
```purescript
@@ -21,14 +26,17 @@ fromString "15013093754529657235677197216425445781404797056873877723589353301606
2126
true
2227
```
2328

24-
## Module documentation
25-
26-
- [Data.BigInt](docs/Data/BigInt.md)
27-
28-
## Installation
29+
## Installation and usage
30+
You can install this package via Bower. You will also need [BigInteger.js](https://github.com/peterolson/BigInteger.js), which can be installed via `npm`:
31+
```
32+
bower install purescript-bigints
33+
npm install big-integer
34+
```
35+
For the browser, remember to bundle `BigInteger.min.js` with your code.
2936

37+
## Development
3038
```
31-
npm install
3239
bower install
33-
gulp
40+
npm install
3441
```
42+
Then, use `pulp` to build, run tests and generate the documentation.

0 commit comments

Comments
 (0)