Skip to content

Commit

Permalink
Update README with todo, contributing & license [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
edennis committed Jan 29, 2018
1 parent 47b25c5 commit 5045c46
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,21 @@ balance1 = client1 |> Krakex.trade_balance(asset: "ZUSD")
balance2 = client2 |> Krakex.trade_balance(asset: "EUR")
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/krakex](https://hexdocs.pm/krakex).
## TODO

- [ ] [Private user funding calls](https://www.kraken.com/help/api#private-user-funding)


## Contributing

1. Fork it (https://github.com/edennis/krakex/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

Copyright (c) 2018 Erick Dennis

0 comments on commit 5045c46

Please sign in to comment.