Skip to content

Add install and usage section to README #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add install and usage section to README #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0e4797
fix: add install and usage sections
whoabuddy Apr 21, 2022
9d4780c
chore: fix typo
whoabuddy Apr 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down Expand Up @@ -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'
Expand Down