diff --git a/README.md b/README.md index 71a754a..8ec9866 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 ``` @@ -93,7 +112,7 @@ ripemd160 hash. ## 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'