Merge pull request #63 from rskvazh/master

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

diff --git a/README.md b/README.md
index d5aef2d89e5babe3516e8858e5d1e5b96d66b302..e8e5a9a305092337913d59d823a29ffc329250a2 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",
@@ -26,25 +32,64 @@ apt::pin { "karmic-security": priority => 700 }
 ### apt::ppa
 Add a ppa repository using `add-apt-repository`.  Somewhat experimental.
 <pre>
-apt::ppa { "ppa:drizzle-developers/ppa" }
+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>
 
-## apt::source
+### apt::source
 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>
+### apt::key
+Add a key to the list of keys used by apt to authenticate packages.
+<pre>
+apt::key { "puppetlabs":
+  key        => "4BD6EC30",
+  key_server => "pgp.mit.edu",
 }
 </pre>
+
+<pre>
+apt::key { "jenkins":
+  key        => "D50582E6",
+  key_source => "http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key",
+}
+</pre>
+
+Note that use of the "key_source" parameter requires wget to be installed and working.
+
+
+## Contributors
+A lot of great people have contributed to this module. A somewhat current list follows.  
+Ben Godfrey <ben.godfrey@wonga.com>  
+Christian G. Warden <cwarden@xerus.org>  
+Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>  
+Garrett Honeycutt <github@garretthoneycutt.com>  
+Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>  
+Ken Barber <ken@bob.sh>  
+Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>  
+Matthias Pigulla <mp@webfactory.de>  
+Monty Taylor <mordred@inaugust.com>  
+Peter Drake <pdrake@allplayers.com>  
+Reid Vandewiele <marut@cat.pdx.edu>  
+Robert Navarro <rnavarro@phiivo.com>  
+Ryan Coleman <ryan@puppetlabs.com>  
+Scott McLeod <scott.mcleod@theice.com>  
+Spencer Krum <spencer@puppetlabs.com>  
+William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>  
+Zach Leslie <zach@puppetlabs.com>