Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
and add reference to secp256k1 script
  • Loading branch information
sneurlax committed Dec 24, 2024
1 parent b966379 commit 1a5df44
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
# `BIP48`
BIP-0048 "Multi-Script Hierarchy for Multi-Sig Wallets" for Dart.
BIP-0048 "Multi-Script Hierarchy for Multi-Sig Wallets" for Dart.

Used to derive "shared accounts" from Hierarchical Deterministic (HD) wallets.

## Getting started
```bash
git clone https://github.com/ManyMath/bip48
cd bip48
dart pub get
dart run coinlib:build_linux
# Refer to
# https://github.com/peercoin/coinlib/tree/master/coinlib#installation-and-usage
# for build instructions for your platform. Basically, use
# `dart run coinlib:build_platform` (select from: `linux`, `macos`, `windows`,
# `windows_crosscompile`, or `wsl`). If these don't work, check for build
# scripts for your platform in the `scripts` folder.
dart test
```

## Usage
See the example and tests for usage.
4 changes: 3 additions & 1 deletion scripts/linux/build_secp256k1.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# This script is provided in case `dart run coinlib:build_linux` fails.
#
# Adapted from Stack Wallet's secp256k1 build script.
# Adapted from Stack Wallet's secp256k1 build script. See
# https://github.com/cypherstack/stack_wallet/tree/staging/scripts for scripts for additional
# platforms.

mkdir -p build
cd build
Expand Down

0 comments on commit 1a5df44

Please sign in to comment.