Skip to content

Commit

Permalink
πŸ“– Readme (#51)
Browse files Browse the repository at this point in the history
* πŸ“– Readme

* Update README.md
  • Loading branch information
tiero authored May 21, 2020
1 parent 949689b commit 5be3e12
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 5be3e12

Please sign in to comment.