Skip to content

Commit

Permalink
doc: begin README
Browse files Browse the repository at this point in the history
  • Loading branch information
coolaj86 committed May 15, 2024
1 parent 49786c9 commit 3dcfdf8
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
# DashJoin.js

A working reference implementation of Coin Join that can easily be ported to any
language.

# Table of Contents

- Install
- RegTest Setup

## Prerequisites (RegTest)

You will need:

- Build Tools
- Docker
- Dashmate
- RegTest

See <https://github.com/dashhive/DashJoin.js/issues/12>.

## Install

```sh
git clone https://github.com/dashhive/DashJoin.js.git
pushd ./DashJoin.js/

npm ci --only=production
```

## How to Mature Coins Quickly

You can generate transactions and blocks (only works on Linux):

```sh
./bin/dash-cli-generateblocks 100
```

0 comments on commit 3dcfdf8

Please sign in to comment.