README.md

random-tree-names

Get random tree names for all your things!

Usable as module, command-line interface and website:

Usage

Module

$ npm install random-tree-names

const treeNames = require('random-tree-names')

treeNames.random()
// => 'chenault-schneebeere'
treeNames.random('en')
// => 'flowering-almira-norway-maple'

Currently we have tree names in en and de.

Browser

git clone https://github.com/perguth/random-tree-names.git
cd random-tree-names
npm install
npm start
// => http://localhost:9966

Or simply click here: https://pguth.github.io/random-tree-names/

Command-line interface

$ npm install -g random-tree-names
$ random-tree-names de
feuer-ahorn

API

languages = randomTreeNames.languages

All available language strings.

allTreeNames = randomTreeNames.all([language])

Tree names in alphabetical order.

allTreeNames = randomTreeNames.random([language])

Random tree name.

CLI

$ npm install -g random-tree-names

$ random-tree-name --help

Usage:
  $ random-tree-names [language]

Commands:
  <default>    Pick a random name from all languages

  Options:
    -h, --help          Print usage
    -a, --all           Print all tree names
    -l, --languages     Print available language strings

Examples:
  $ random-tree-names                       # prints a random tree name
  $ random-tree-names -a                    # lists all tree names
  $ random-tree-names en -a                 # lists all english tree names

Tree name sources

• English: hort.ifas.ufl.edu
• German: baumkunde.de

If you know a good source for any other language please open an issue.

License

MIT