From c430c5b73ad9b8090b4b7c0e844549c4d6cdb455 Mon Sep 17 00:00:00 2001 From: "[Alt'tiRi]" <16310547+AlttiRi@users.noreply.github.com> Date: Thu, 23 Jun 2022 14:46:20 +0300 Subject: [PATCH] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 08e7f2a..d29ea79 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ Aimed to encoding binary data (`Uint8Array`). ---- + +## API ### `function encode(ui8a: Uint8Array, charset?: "ascii85" | "z85" | String) : String` @@ -15,7 +16,9 @@ Aimed to encoding binary data (`Uint8Array`). `charset` is "z85" by default. ---- + +## Examples + Binary data encoding example: ```js @@ -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