From c0e4797a7bccc4919ad195fbae10a9287a2449e4 Mon Sep 17 00:00:00 2001 From: Jason Schrader Date: Thu, 21 Apr 2022 10:30:52 -0700 Subject: [PATCH 1/2] fix: add install and usage sections --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 71a754a..62e6aaf 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,25 @@ Specific to Blockstack, the Stacks blockchain uses c32-encoded public key hashes as addresses. Specifically, a **c32check address** is a c32check-encoded ripemd160 hash. +## Installation + +To build the c32check library, run: + +``` +npm i +npm run build +``` + +## Usage + +To enable access to the functions listed under examples, run: + +``` +cd dist +node +.load c32check.js +``` + # Examples ``` From 9d4780c3796c598ad7a9873ef4e0aa88e9b7ded0 Mon Sep 17 00:00:00 2001 From: Jason Schrader Date: Thu, 21 Apr 2022 10:31:28 -0700 Subject: [PATCH 2/2] chore: fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 62e6aaf..8ec9866 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ node ## c32ToB58, b58ToC32 **NOTE**: Common address versions are converted between c32check -and base58check seamlessly, in order to accomodate Stacks addresses. +and base58check seamlessly, in order to accommodate Stacks addresses. ``` > b58addr = '16EMaNw3pkn3v6f2BgnSSs53zAKH4Q8YJg'