kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

(PDOC-70) Update rake task documentation 

Prior to this commit, the rake task section of the README did not
reflect that strings:generate rake task would also create a strings.json
file. Update the README to include this detail.
This commit is contained in:
Hailee Kenney 2016-03-24 23:32:10 -07:00
parent 678ba735e8
commit 946cae44a0
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -223,6 +223,9 @@ Rake Tasks
This module is also available as a Gem and makes two rake tasks (`strings:generate` and `strings:serve`) available in `puppet-strings/rake_tasks`. To add this to your module's CI workflow, be sure to add this module to your `Gemfile`:
In addition to generating the usual 'doc' directory of HTML documentation, the `strings:generate` rake task will also
drop a strings.json file containing a JSON representation of the module into the directory the rake task was run from.
```ruby
gem 'puppet-strings', :git => 'https://github.com/puppetlabs/puppetlabs-strings.git'
```