README.md
# Punycode
[![Package Version](https://img.shields.io/hexpm/v/punycode)](https://hex.pm/packages/punycode)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/punycode/)
## Quick start
```gleam
import punycode
import gleam/io
// will print elkjp-yua
case punycode.encode("elkjøp") {
Ok(encoded) -> io.println(encoded)
Error(Nil) -> io.println("Encoding failed")
}
// will print elkjøp
case punycode.decode("elkjp-yua") {
Ok(encoded) -> io.println(encoded)
Error(Nil) -> io.println("Encoding failed")
}
```
```sh
gleam test # Run the tests
```
## Installation
If available on Hex this package can be added to your Gleam project:
```sh
gleam add punycode
```
and its documentation can be found at <https://hexdocs.pm/punycode>.