# friendly_id
[](https://hex.pm/packages/friendly_id)
[](https://hexdocs.pm/friendly_id/)
A port of [FriendlyID](https://github.com/Miserlou/FriendlyID) to Gleam! This package creates human-readable, friendly identifiers.
For example, instead of using:
`https://chat.room/r/7051d892-7d9d-4d38-b718-1f22f5b52d70`
You can create something like:
`https://chat.room/r/ShinyPenguin`
Which makes the URL easier to share.
Words come from the [Glitch Project](https://github.com/glitchdotcom/friendly-words) and are curated to be inoffensive, safe for work and safe for children.
There's 3064 objects and 1450 predicates, which means there's 4,442,800 possible combinations.
```sh
gleam add friendly_id@1
```
```gleam
import friendly_id
import gleam/string
pub fn main() {
let generator = friendly_id.new_generator(string.capitalize, "_")
echo generator.generate(generator)
}
```
```
"Recondite-Leader"
```
Further documentation can be found at <https://hexdocs.pm/friendly_id>.
## Development
```sh
gleam run # Run the project
gleam test # Run the tests
```
## License
Word lists are provided by [Glitch](https://github.com/glitchdotcom/friendly-words).
MIT License
Copyright (c) 2021 Rich Jones
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
