Document default values

appium · Aug 4, 2014 · 494e083 · 494e083
1 parent 5085c84
commit 494e083
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@ Appium Thor helpers for appium's gems (appium_lib, appium_capybara).
 ```ruby
 Appium::Thor::Config.set do
   gem_name     'appium_thor'
+  github_owner 'appium'
   github_name  'appium_thor'
   version_file 'lib/appium_thor/version.rb'
   docs_block do
@@ -18,6 +19,17 @@ Appium::Thor::Config.set do
 end
 ```
 
+# Defaults
+
+      Option | Default
+          --:|:--
+gem_name     | must be provided
+github_owner | `appium`
+github_name  | gem_name
+version_file | `lib/#{gem_name}/version.rb`
+docs_block   | no docs are generated
+
+
 --
 
 # Available tasks