Introduce the random animal generator machine

.gitignore

@@ -1,59 +1 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Typescript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
+node_modules

README.md

@@ -1,2 +1,46 @@
 # random-animal-name-generator
+
 It's a random animal name generator!
+
+```js
+  const generateRandomAnimalName = require('animal-name-generator')
+  const animalName = generateRandomAnimalName()
+  console.log(animalName)
+```
+
+With funny animal names!
+
+```
+Wistful wildcat
+Low-budget llama
+Grudging giraffe
+Knowing kangaroo
+Cantankerous canary
+Midterm mountain goat
+Keyed koala
+Blessed bat
+Journalistic jackal
+Bungling baboon
+Newest newt
+Illustrative ibex
+Comely cat
+Envious ewe
+Widen weasel
+Risque rat
+Dread dromedary
+```
+
+## Corpora
+
+Adjectives and animal names are taken from the [https://github.com/dariusk/corpora](Corpora) project.
+
+## Development
+
+Clone the repository and install all dependencies:
+
+```
+git clone [email protected]:adzialocha/random-animal-name-generator.git
+cd random-animal-name-generator
+npm install
+npm run test
+```