Skip to content

Commit 52470c5

Browse files
committed
doc: begin README
1 parent cb8c3bf commit 52470c5

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,37 @@
11
# DashJoin.js
2+
3+
A working reference implementation of Coin Join that can easily be ported to any
4+
language.
5+
6+
# Table of Contents
7+
8+
- Install
9+
- RegTest Setup
10+
11+
## Prerequisites (RegTest)
12+
13+
You will need:
14+
15+
- Build Tools
16+
- Docker
17+
- Dashmate
18+
- RegTest
19+
20+
See <https://github.com/dashhive/DashJoin.js/issues/12>.
21+
22+
## Install
23+
24+
```sh
25+
git clone https://github.com/dashhive/DashJoin.js.git
26+
pushd ./DashJoin.js/
27+
28+
npm ci --only=production
29+
```
30+
31+
## How to Mature Coins Quickly
32+
33+
You can generate transactions and blocks (only works on Linux):
34+
35+
```sh
36+
./bin/dash-cli-generateblocks 100
37+
```

0 commit comments

Comments
 (0)