summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLamont Granquist <lamont@scriptkiddie.org>2016-03-30 17:41:00 -0700
committerLamont Granquist <lamont@scriptkiddie.org>2016-03-30 17:41:00 -0700
commitce357df7c2e418fc7543a1a4f105e8edbf35f6f8 (patch)
tree4f324368fe21b66eb9fa7dbcbb5c2f7cc0b73dae
parentaca1514f14c4dcc06e612f34b1b6852675962824 (diff)
parentf86adc544f2c0070221c3e27f0a6ed1ed25255b9 (diff)
downloadmixlib-cli-ce357df7c2e418fc7543a1a4f105e8edbf35f6f8.tar.gz
Merge pull request #26 from chef/jr/readme-fix
Fix README.md options formatting
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 6a4d8f9..db22149 100644
--- a/README.md
+++ b/README.md
@@ -73,8 +73,8 @@ Available arguments to 'option':
- `:description`: The description for this item, just like from optparse.
- `:default`: A default value for this option
- `:required`: Prints a message informing the user of the missing requirement, and exits. Default is false.
-- `:on`: Set to :tail to appear at the end, or
-- :head to appear at the top. :boolean:: If this option takes no arguments, set this to true.
+- `:on`: Set to :tail to appear at the end, or `:head`: to appear at the top.
+- `:boolean:`: If this option takes no arguments, set this to true.
- `:show_options`: If you want the option list printed when this option is called, set this to true.
- `:exit`: Exit your program with the exit code when this option is specified. Example: 0
- `:proc`: If set, the configuration value will be set to the return value of this proc.
@@ -106,4 +106,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-``` \ No newline at end of file
+```