Skip to content

Commit

Permalink
docs: update readme (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
niklasvh committed Aug 10, 2021
1 parent 2ca97db commit 0a0253d
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Expand Up @@ -6,15 +6,22 @@

Encode/decode base64 data into ArrayBuffers

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

npm install base64-arraybuffer

## API
The library encodes and decodes base64 to and from ArrayBuffers

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

### Testing
You can run the test suite with:

npm test

## License
Copyright (c) 2012 Niklas von Hertzen
Licensed under the MIT license.

0 comments on commit 0a0253d

Please sign in to comment.