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

Merge pull request #78 from HAIL9000/maint/master/PDOC-70_update_rake_task_readme 

(PDOC-70) Update rake task documentation
This commit is contained in:
Kylo Ginsberg 2016-03-25 09:52:41 -07:00
parent ffb387fec5 946cae44a0
commit 015ce70f5a
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

@ -242,6 +242,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'
```