Skip to content

Commit

Permalink
Update README.md for release v0.6.0 (#219)
Browse files Browse the repository at this point in the history
- Include currency as a feature.
- Include links to video tutorial on perunnodetui app.

Resolves #189.

Signed-off-by: Manoranjith <ponraj.manoranjitha@in.bosch.com>
  • Loading branch information
manoranjith committed Jul 8, 2021
1 parent bf34a66 commit 41c8df9
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ The current version provides the following features:
|User API|Two Party Payment API |
|User API Adapter|gRPC |
|Persistence|LevelDB|
|Currencies|ETH, Any ERC20 token|

This project currently contains two executable packages located in the `cmd` directory.
This project currently contains three executable packages located in the `cmd` directory.

- `perunnode`: An app for starting a running instance of perun node. It can
also generate configuration artifacts for trying out the node.
Expand All @@ -67,11 +68,18 @@ This project currently contains two executable packages located in the `cmd` dir
- reference implementation for using the generated grpc client stubs for
payment channel API.

For detailed information on the features offered by these two applications and
steps on how to try them out, see the
- `perunnodetui` is an app with interactive text based user interface. With
visual representation most of the actions, it is easy way to try out payment
channel API and understand the perun protocol.

For a tutorial on using perun-node with `perunnodecli`, see the
[tutorial section](https://labs.hyperledger.org/perun-doc/node/introduction.html#user-guide)
on the project documentation website. For a tutorial using for `perunnodetui`, see
[this section](cmd/perunnodetui/Readme.md).
on the project documentation website.

For a tutorial on using perun-node with `perunnodetui`, see
[this section](cmd/perunnodetui/Readme.md). A talk on overview of perun,
including a hands-on demo of using the perunnode with `perunnodetui` can be
found [here](https://youtu.be/sASYSJm3QKw?t=916).

## Getting Started

Expand Down Expand Up @@ -108,11 +116,10 @@ golangci-lint run ./...
# Test
go test -tags=integration -count=1 ./...

# Build peurnnode and perunnodecli binaries
# Build perunnode and perunnodecli binaries
make
```


## License

perun-node is open-sourced under the Apache-2.0 license. See the
Expand Down
12 changes: 6 additions & 6 deletions cmd/perunnodetui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@ Perun Node TUI is a text based UI client for trying out the perun payment
channels in a graphical way. This software is completely independent from the
perun-node. It uses the grpc interface to interact with it.

A video tutorial on using the perunnode tui can be found
[here](https://youtu.be/sASYSJm3QKw?t=916).

To use this application, we need to start the `perun node` and a blockchain
node (preferably using `ganache-cli`). Detailed steps for setting up these
components are described in the
[project documentation](https://labs.hyperledger.org/perun-doc/node/user_guide.html#getting-started).

Once you have started the perun-node and the ganache-cli nodes, you can start
the `perunnodetui` by running the below commands in two different terminals
(from the perun-node directory).

the `perunnodetui` in two different terminals. The `perunnodetui` binary would
have been generated by the make command in the perun-node directory.

```
cd cmd/perunnodetui
go build && ./perunnodetui -alice -deploy
./perunnodetui -alice -deploy
```

```
cd cmd/perunnodetui
go build && ./perunnodetui -bob
```

Expand Down

0 comments on commit 41c8df9

Please sign in to comment.