summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-07-30 09:03:36 -0700
committerTim Smith <tsmith@chef.io>2018-07-30 09:03:36 -0700
commitcfcb97655ac7fa32e4c7a32a1c5f8ca0c6726629 (patch)
tree6a742437b3868148fe78daf82796ec2407ad9c5a /README.md
parent87681b1af636ea79167d02afaf5931eb8c85bec7 (diff)
downloadmixlib-cli-cfcb97655ac7fa32e4c7a32a1c5f8ca0c6726629.tar.gz
Move dev deps to the Gemfile and add console task
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7dd7477..1309e63 100644
--- a/README.md
+++ b/README.md
@@ -88,9 +88,17 @@ cli.parse_options
cli.cli_arguments # [ 'file1', 'file2', 'file3' ]
```
+## Documentation
+
+All documentation is written using YARD. You can generate a by running:
+
+```
+rake yard
+```
+
## Contributing
-For information on contributing to this gem please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md)
+For information on contributing to this project please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md)
## License & Copyright