feat(cli): Add documentation 📖

README.md

@@ -192,6 +192,14 @@ Faker::Name.name      #=> "Christophe Bartell"
 Faker::Internet.email #=> "[email protected]"
 ```
 
+### CLI
+
+Usage Instructions [available here](https://github.com/stympy/faker/blob/master/lib/cli/README.md)
+
+```bash
+$ faker
+```
+
 ### Ensuring unique values
 
 Prefix your method call with `unique`. For example:
@@ -256,15 +264,15 @@ en-au-ocker:
   faker:
     name:
       # Existing faker field, new data
-      first_name: 
+      first_name:
         - Charlotte
         - Ava
         - Chloe
         - Emily
 
       # New faker fields
-      ocker_first_name: 
-        - Bazza 
+      ocker_first_name:
+        - Bazza
         - Bluey
         - Davo
         - Johno

lib/cli/README.md

@@ -0,0 +1,55 @@
+# faker (cli)
+
+## Usage
+
+1.) Run a quick lookup
+
+```bash
+$ faker search name
+# Faker::SwordArtOnline
+# └── real_name
+# └── game_name
+# Faker::Superhero
+# └── name
+# ....
+```
+
+2.) List methods
+
+```sh
+$ faker list
+# Faker::BackToTheFuture
+# ├── quote
+# ├── date
+# └── character
+# Faker::Finance
+# └── credit_card
+# ....
+```
+
+`faker` also includes an option to display sample output via the `--verbose` or `-v` flag. :wink:
+
+3.)
+
+```sh
+$ faker list -v
+# Faker::Appliance
+# ├── brand=> Whirlpool
+# └── equipment=> Sump pump
+# Faker::UmphreysMcgee
+# └── song=> Headphones & Snowcones
+$ faker search name -v
+# Faker::App
+# └── name=> Subin
+# Faker::Address
+# └── street_name=> Percy Landing
+# ....
+```
+
+## Features! :sunglasses: :dancers:
+
+- [x] List classes with methods E.g. Faker::FunnyName is displayed with `.name`,`.first_name` e.t.c.
+- [x] Expand search to Faker::Base sub classes
+- [x] Paginate results :book:
+
+![screenshot 2019-01-05 at 03 02 08](https://user-images.githubusercontent.com/17295175/50717135-59d85780-1096-11e9-8d0d-eca95646644d.jpg)