From 41c8df99e89349b86a30572e6f3ded38b6ed0da5 Mon Sep 17 00:00:00 2001 From: manoranjith Date: Thu, 8 Jul 2021 14:39:20 +0530 Subject: [PATCH] Update README.md for release v0.6.0 (#219) - Include currency as a feature. - Include links to video tutorial on perunnodetui app. Resolves #189. Signed-off-by: Manoranjith --- README.md | 21 ++++++++++++++------- cmd/perunnodetui/README.md | 12 ++++++------ 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a28cdfd5..e680e843 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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 diff --git a/cmd/perunnodetui/README.md b/cmd/perunnodetui/README.md index 3c5962df..9eb3c1b0 100644 --- a/cmd/perunnodetui/README.md +++ b/cmd/perunnodetui/README.md @@ -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 ```