Correct spelling typo in CHANGELOG

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

diff --git a/README.md b/README.md
index 4ab857fb1118d43702f65907e8f02b13720b1994..2ce5340ab62dfd128e7db318019a046d2813ad1d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,11 @@
 apt
 ===
 
 apt
 ===
 

+[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt)
+
+## Description
+Provides helpful definitions for dealing with Apt.
+=======

 Overview
 --------
 
 Overview
 --------
 


@@ -49,7 +54,8 @@ The parameters for `apt` are not required in general and are predominantly for d
       proxy_port           => '8080',
       purge_sources_list   => false,
       purge_sources_list_d => false,
       proxy_port           => '8080',
       purge_sources_list   => false,
       purge_sources_list_d => false,

-      purge_preferences_d  => false
+      purge_preferences_d  => false,
+      update_timeout       => undef

     }
 
 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content. 
     }
 
 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content. 


@@ -96,6 +102,16 @@ Adds an apt pin for a certain release.
     apt::pin { 'karmic-updates': priority => 700 }
     apt::pin { 'karmic-security': priority => 700 }
 
     apt::pin { 'karmic-updates': priority => 700 }
     apt::pin { 'karmic-security': priority => 700 }
 

+Note you can also specifying more complex pins using distribution properties.
+
+    apt::pin { 'stable':
+      priority        => -10,
+      originator      => 'Debian',
+      release_version => '3.0',
+      component       => 'main',
+      label           => 'Debian'
+    }
+

 ###apt::ppa
 
 Adds a ppa repository using `add-apt-repository`.
 ###apt::ppa
 
 Adds a ppa repository using `add-apt-repository`.


@@ -106,7 +122,9 @@ Adds a ppa repository using `add-apt-repository`.
 
 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 
 
 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 

-    apt::release { 'karmic': }
+    class { 'apt::release':
+      release_id => 'precise',
+    }

 
 ###apt::source
 
 
 ###apt::source
 


@@ -206,10 +224,3 @@ A lot of great people have contributed to this module. A somewhat current list f
 * Spencer Krum <spencer@puppetlabs.com>  
 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>  
 * Zach Leslie <zach@puppetlabs.com>  
 * Spencer Krum <spencer@puppetlabs.com>  
 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>  
 * Zach Leslie <zach@puppetlabs.com>  

-
-Release Notes
--------------
-
-**1.1.0**
-
-This release includes Ubuntu 12.10 (Quantal) support for PPAs.
\ No newline at end of file