https://github.com/botsquad/hukai

Pronouncable name generator in Elixir
https://github.com/botsquad/hukai

Last synced: 15 days ago
JSON representation

Pronouncable name generator in Elixir

• Host: GitHub
• URL: https://github.com/botsquad/hukai
• Owner: botsquad
• License: mit
• Created: 2019-06-17T13:47:05.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-09-16T06:42:54.000Z (over 4 years ago)
• Last Synced: 2024-11-30T17:18:02.422Z (about 1 month ago)
• Language: Elixir
• Homepage:
• Size: 113 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hukai

Generate Heroku-like pronouncable strings in Elixir; inspired by [spicy proton](https://github.com/schmich/spicy-proton).

Thanks to [NLTK](http://www.nltk.org/) for the word corpus.

Word lists are stored in runtime in a public-read ETS table.

## Usage

```elixir

Hukai.generate("%n")

```

Patterns:

`%n` - a noun (max 6 letters)

`%a` - an adjective (max 6 letters)

`%b` - an adverb

`%v` - a verb

`%C` - a color

`%A` - an animal

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed

by adding `hukai` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:hukai, "~> 0.1.0"}

  ]

end

```

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/hukai](https://hexdocs.pm/hukai).