(#12094) Add rspec-puppet tests for apt

[puppet-modules/puppetlabs-apt.git] / README.md

diff --git a/README.md b/README.md
index 8beee7cf3b999b50f4243897674a902a6fcd6757..0c61866b0cec5a4ef4cf9da2e8a98c73d5cf3312 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,8 +5,14 @@ Provides helpful definitions for dealing with Apt.
 
 ## Usage
 
+### apt:builddep
+Install the build depends of a specified package.
+<pre>
+apt::builddep { "glusterfs-server": }
+</pre>
+
 ### apt::force
-Force a package to be installed from a specific release.  Useful when using repositoires like Debian unstable in Ubuntu.
+Force a package to be installed from a specific release.  Useful when using repositories like Debian unstable in Ubuntu.
 <pre>
 apt::force { "glusterfs-server":
        release => "unstable",
@@ -30,7 +36,7 @@ apt::ppa { "ppa:drizzle-developers/ppa": }
 </pre>
 
 ### apt::release
-Set the default apt release.  Useful when using repositoires like Debian unstable in Ubuntu.
+Set the default apt release.  Useful when using repositories like Debian unstable in Ubuntu.
 <pre>
 apt::release { "karmic": }
 </pre>
@@ -39,12 +45,13 @@ apt::release { "karmic": }
 Add an apt source to `/etc/apt/sources.list.d/`.
 <pre>
 apt::source { "debian_unstable":
-       location => "http://debian.mirror.iweb.ca/debian/",
-       release => "unstable",
-       repos => "main contrib non-free",
-       required_packages => "debian-keyring debian-archive-keyring",
-       key => "55BE302B",
-       key_server => "subkeys.pgp.net",
-       pin => "-10"
+  location          => "http://debian.mirror.iweb.ca/debian/",
+  release           => "unstable",
+  repos             => "main contrib non-free",
+  required_packages => "debian-keyring debian-archive-keyring",
+  key               => "55BE302B",
+  key_server        => "subkeys.pgp.net",
+  pin               => "-10",
+  include_src       => true
 }
 </pre>