Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlttiRi authored Jun 23, 2022
1 parent 68367fb commit c430c5b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

Aimed to encoding binary data (`Uint8Array`).

---

## API

### `function encode(ui8a: Uint8Array, charset?: "ascii85" | "z85" | String) : String`

Expand All @@ -15,7 +16,9 @@ Aimed to encoding binary data (`Uint8Array`).

`charset` is "z85" by default.

---

## Examples


Binary data encoding example:
```js
Expand Down Expand Up @@ -77,7 +80,7 @@ npm install @alttiri/base85
```
Note, that GitHub Packages requires to have also `~/.npmrc` file by `//npm.pkg.github.com/:_authToken=TOKEN` content, where `TOKEN` is a token with the `read:packages` permission, take it here https://github.com/settings/tokens/new.

### From GitHub:
### From GitHub
Or install the lastest version from GitHub directly:
```bash
npm install git+https://github.com/AlttiRi/base85.git
Expand Down

0 comments on commit c430c5b

Please sign in to comment.