https://github.com/waterlink/namegen.cr

This library provides facilities for generating random names/nicknames. Written in Crystal-Lang.
https://github.com/waterlink/namegen.cr

Last synced: 30 days ago
JSON representation

This library provides facilities for generating random names/nicknames. Written in Crystal-Lang.

• Host: GitHub
• URL: https://github.com/waterlink/namegen.cr
• Owner: waterlink
• License: mit
• Created: 2015-09-10T19:41:57.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-10T19:42:10.000Z (over 9 years ago)
• Last Synced: 2024-10-16T07:16:17.862Z (3 months ago)
• Language: Crystal
• Size: 125 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# namegen.cr

This library provides facilities for generating random names/nicknames.

## Current supported languages

- `Namegen::Language::EN_US`

- `Namegen::Language::DE`

If you want to add new languages, take a look at `src/data` folder and add new

language in the same format. Additionally add new constant in

`Namegen::Language`. Then create a PR.

## Installation

Add this line to your application's `Projectfile`:

```crystal

deps do

  github "waterlink/namegen.cr"

end

```

## Usage

```crystal

require "namegen"

```

### Generating a name

```crystal

g = Namegen.generator(Namegen::Language::DE, Namegen::Gender::FEMALE)

g.name

# => Zemda

```

### Example: Checking how unique names it is generating:

```crystal

require "namegen"

n = 1000000

g = Namegen.generator(Namegen::Language::DE, Namegen::Gender::FEMALE)

names = {} of String => Int32

(0..n).each do |i|

  name = g.name()

  names[name] ||= 0

  names[name] += 1

  puts "#{i} - #{name}"

end

puts "unique names: #{names.size} out of #{n}"

```

## Contributing

1. Fork it ( https://github.com/waterlink/namegen.cr/fork )

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

## Contributors

- [waterlink](https://github.com/waterlink) Oleksii Fedorov - creator, maintainer