From 946cae44a04b7eb7c6c37e572bf5c4ee53d54bc4 Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Thu, 24 Mar 2016 23:32:10 -0700 Subject: [PATCH] (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. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9fe98a7..042c87b 100644 --- a/README.md +++ b/README.md @@ -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' ```