README.md
# Cashaddr
Library for decoding and validating CashAddr btc cash addresses.
Implements CashAddr encoding and decoding specified by [Address format for Bitcoin Cash v 1.0](https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/cashaddr.md)
## Installation
The package can be installed by adding `cashaddr` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:cashaddr, "~> 0.1.0"}
]
end
```
## Usage
Add plug invocation in your `Endpoint` pipeline just after `Plug.Static`:
```elixir
CashAddr.encode("prefix", "hełło")
CashAddr.decode("bitcoincash:qph5kuz78czq00e3t85ugpgd7xmer5kr7c5f6jdpwk")
```
## Documentation
Docs can be found at [https://hexdocs.pm/cashaddr](https://hexdocs.pm/cashaddr).
## License
CashAddr source code is released under MIT License.
Check LICENSE file for more information.