Skip to content

Commit

Permalink
Update README.md (iron-fish#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
dguenther authored Apr 7, 2021
1 parent a4f3862 commit b184a9f
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions ironfish-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
[![codecov](https://codecov.io/gh/iron-fish/ironfish/branch/master/graph/badge.svg?token=PCSVEVEW5V&flag=ironfish-cli)](https://codecov.io/gh/iron-fish/ironfish)

The main entry point for an ironfish CLI that is capable of mining blocks and spending notes. It's created using the [oclif CLI framework](https://oclif.io)
The main entry point for an Iron Fish CLI that is capable of mining blocks and spending notes. It's created using the [oclif CLI framework](https://oclif.io)

## Starting the CLI

Build, run, and restart when the code changes:

- `yarn start`

Build, then run the CLI without watching for changes:

- `yarn start:once`

## Use Scenarios

Expand Down Expand Up @@ -49,4 +59,4 @@ yarn start:once start --datadir ~/.ironfish2 --port 9034 --bootstrap ws://localh

# in tab 4
yarn start:once miners:start --datadir ~/.ironfish2
```
```

0 comments on commit b184a9f

Please sign in to comment.