Skip to content

Commit e09effb

Browse files
committed
Update README.md
1 parent 6cd9bb4 commit e09effb

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
11
# n32
22

33
> Express numbers in a form that can be conveniently and accurately transmitted between humans and computers.
4+
5+
## Install
6+
7+
```sh
8+
npm i @simonsinclair/n32
9+
```
10+
11+
## Usage
12+
13+
```js
14+
const { default: n32 } = require('@simonsinclair/n32');
15+
16+
const randomNumber = 123456789;
17+
const friendlyId = n32(randomNumber);
18+
19+
console.log(friendlyId);
20+
```
21+
22+
```js
23+
'3nqk8n';
24+
```
25+
26+
## API
27+
28+
### n32(number)
29+
30+
Returns a string.
31+
32+
#### number
33+
34+
Type: `number`.
35+
36+
The number to express.
37+
38+
## Supported browsers
39+
40+
IE11, and all modern browsers.

0 commit comments

Comments
 (0)