From 5be3e1260f5974ef829e1c33a48d4633d4eb14e8 Mon Sep 17 00:00:00 2001 From: Marco Argentieri Date: Thu, 21 May 2020 16:38:26 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Readme=20(#51)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 📖 Readme * Update README.md --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0b8095b..1d4c8d8 100644 --- a/README.md +++ b/README.md @@ -30,26 +30,36 @@ Go support for confidential transactions on Elements-based blockchains - [ ] Slip77 - [ ] Signing a confidential input (use 0 value amounts to produce the hash for the signature) -## Development +## 🖥 Development -Clone repository: +* Clone repository: ```sh $ git clone https://github.com/vulpemventures/go-elements.git ``` -Enter into the project folder and install dependencies: +* Enter into the project folder and install dependencies: ```sh $ cd go-elements $ go get -t -v ./... ``` -For running tests it is required to have a running Nigiri locally, or at least a remote one reachable from the outside. -To run the tests it is mandatory to export an `API_URL` environment vriable pointing to the url of nigiri-chopsitcks. -Example having a local Nigiri running: +* Run tests + +> For running tests it is required to have a running [Nigiri](https://github.com/vulpemventures/nigiri) locally, or at least a remote one reachable from the outside. + To run the tests it is mandatory to export an `API_URL` environment variable pointing to the URL of `nigiri-chopsticks`. ``` +$ nigiri start --liquid $ export API_URL=http://localhost:3001 $ go test ./... -v ``` + +## 👷‍♂️ Contributors + +* [@tiero](https://github.com/tiero) +* [@altafan](https://github.com/altafan) +* [@sekulicd](https://github.com/sekulicd) + +## License [MIT](https://github.com/vulpemventures/go-elements/blob/master/LICENSE)