Updated docs

bryanjos · May 10, 2015 · 9c2946d · 9c2946d
1 parent 7353ffc
commit 9c2946d
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -17,16 +17,28 @@ or looks for the following environment variables
 Usage for CLI Client:
 
 ```
-usage: marvel <command> [options]
-
-commands:
-  characters  Gets character data
-
-options:
--s  --search  [searchText]  searches for characters that begin with the searchText
--i  --id [id]               the id of the character
--co --comics                the comics for the character
--ev --events                the events for the character
--se --series                the series for the character
--st --stories               the stories for the character
+  usage: marvel <command> [options]
+
+  commands:
+    characters    Gets character data.
+    comics        Gets comic data.
+    creators      Gets creator data.
+    events        Gets event data.
+    series        Gets series data.
+    stories       Gets story data.
+
+  "entity" in the options below correspond to the commands above.
+  You cannot the option if it has the same name as the command
+
+  invalid ex: marvel characters --characters
+
+  options:
+    -s  --search  [searchText]  searches for entities that begin with the searchText
+    -i  --id [id]               the id of the entity
+    -co --comics                the comics for the entity
+    -ev --events                the events for the entity
+    -se --series                the series for the entity (does not work for comics)
+    -st --stories               the stories for the entity
+    -ch --characters            the characters for the entity (does not work for creators)
+    -ch --creators              the creators for the entity (does not work for characters)
 ```
diff --git a/lib/marvel.ex b/lib/marvel.ex
@@ -7,29 +7,42 @@ defmodule Marvel do
     * `public_key` - Your Marvel Public Key
     * `private_key` - Your Marvel Private Key
 
-
+    <br/>
     or looks for the following environment variables
 
-
+    <br/>
     * `MARVEL_PUBLIC_KEY` - Your Marvel Public Key
     * `MARVEL_PRIVATE_KEY` - Your Marvel Private Key
 
+    <br/>
 
     Usage for CLI Client:
 
     ```
-    usage: marvel <command> [options]
-
-    commands:
-      characters  Gets character data
-
-    options:
-    -s  --search  [searchText]  searches for characters that begin with the searchText
-    -i  --id [id]               the id of the character
-    -co --comics                the comics for the character
-    -ev --events                the events for the character
-    -se --series                the series for the character
-    -st --stories               the stories for the character
+      usage: marvel <command> [options]
+
+      commands:
+        characters    Gets character data.
+        comics        Gets comic data.
+        creators      Gets creator data.
+        events        Gets event data.
+        series        Gets series data.
+        stories       Gets story data.
+
+      "entity" in the options below correspond to the commands above.
+      You cannot the option if it has the same name as the command
+
+      invalid ex: marvel characters --characters
+
+      options:
+        -s  --search  [searchText]  searches for entities that begin with the searchText
+        -i  --id [id]               the id of the entity
+        -co --comics                the comics for the entity
+        -ev --events                the events for the entity
+        -se --series                the series for the entity (does not work for comics)
+        -st --stories               the stories for the entity
+        -ch --characters            the characters for the entity (does not work for creators)
+        -ch --creators              the creators for the entity (does not work for characters)
     ```
   """
 end
diff --git a/lib/marvel/api/base.ex b/lib/marvel/api/base.ex
@@ -1,4 +1,5 @@
 defmodule Marvel.API.Base do
+  @moduledoc false
 
   defmacro __using__(opts) do
     quote do