Shard Detail

haikunator v0.1.0

Heroku-like random name generator

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development


haikunator:
  github: osfx/haikunator

Readme

Haikunator

Generate Heroku-like memorable random names to use in your apps or anywhere else.

Installation

Add this to your application's shard.yml:

dependencies:
  haikunator:
    github: osfx/haikunator

Usage

require "haikunator"

Haikunator.haikunate # => "rough-snowflake-1142"

# Token range
Haikunator.haikunate(100) # => "nameless-star-13"

# Don't include the token
Haikunator.haikunate(0) # => "long-flower"

# Use a different delimiter
Haikunator.haikunate(9999, ".") # => "cool.leaf.6743"

# No token, no delimiter
Haikunator.haikunate(0, " ") # => "green fire"


TODO: Write usage instructions here

Development

To run tests

crystal spec

Contributing

  1. Fork it ( https://github.com/sanata-/haikunator/master )
  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 a new Pull Request

Language Ports

Haikunator based on Usman Bashir awesome gem and also have ports to other languages.

Maintainer