Skip to content

Commit 0a0253d

Browse files
authored
docs: update readme (niklasvh#29)
1 parent 2ca97db commit 0a0253d

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,22 @@
66

77
Encode/decode base64 data into ArrayBuffers
88

9-
## Getting Started
10-
Install the module with: `npm install base64-arraybuffer`
9+
### Installing
10+
You can install the module via npm:
1111

12+
npm install base64-arraybuffer
13+
1214
## API
1315
The library encodes and decodes base64 to and from ArrayBuffers
1416

1517
- __encode(buffer)__ - Encodes `ArrayBuffer` into base64 string
1618
- __decode(str)__ - Decodes base64 string to `ArrayBuffer`
1719

20+
### Testing
21+
You can run the test suite with:
22+
23+
npm test
24+
1825
## License
1926
Copyright (c) 2012 Niklas von Hertzen
2027
Licensed under the MIT license.

0 commit comments

Comments
 (0)