From 2dcf54a08eb666b480d7888c953e5e47e706f73f Mon Sep 17 00:00:00 2001 From: Gabriel Nagy Date: Wed, 6 May 2020 15:31:40 +0300 Subject: (maint) Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7aed631..3460895 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To generate documentation locally, run the following command: ``` bundle install -bundle exec puppet strings generate ./lib/**/*.rb +bundle exec puppet strings generate --format markdown --out REFERENCE.md ``` This command will create a browsable \_index.html file in the doc directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated. -- cgit v1.2.3