[DRE-commits] [librarian-puppet] 26/153: docs on how to specify forge API version

[Stig Sandbeck Mathisen]

This is an automated email from the git hooks/post-receive script.

ssm pushed a commit to branch master
in repository librarian-puppet.

commit d5f3dbf4d066dd498e614a8e93ff893e7135977b
Author: Johan Haals <johan.haals at gmail.com>
Date:   Thu Jul 17 11:25:18 2014 +0200

    docs on how to specify forge API version
---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index b7b83df..6c3d6cc 100644
--- a/README.md
+++ b/README.md
@@ -161,6 +161,14 @@ source specified.  This command writes the complete resolution into
 `Puppetfile.lock` and then copies all of the fetched modules into your
 `modules/` directory, overwriting whatever was there before.
 
+Librarian-puppet support both v1 and v3 of the Puppet Forge API.
+Specify a specific API version when installing modules:
+
+    $ librarian-puppet install --use-v1-api # this is default
+    $ librarian-puppet install --no-use-v1-api # use the v3 API
+
+Please note that this does not apply for the official Puppet Forge where v3 is used by default.
+
 Get an overview of your `Puppetfile.lock` with:
 
     $ librarian-puppet show

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/librarian-puppet.git