Merge pull request #711 from icann-dns/fix_legacy_functions

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

diff --git a/README.md b/README.md
index efea96351c56774ad35b0906682abd2daf584664..7c7a7b33fae65bcb5ab7921e696c9d537d4cbb98 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@
     * [Defined Types](#defined-types)
     * [Types](#types)
     * [Facts](#facts)
+    * [Tasks](#tasks)
 6. [Limitations - OS compatibility, etc.](#limitations)
 7. [Development - Guide for contributing to the module](#development)
 
@@ -264,6 +265,10 @@ apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports":
 
 * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
 
+### Tasks
+
+The Apt module has an example task that allows a user to run apt-get update or upgrade. Please refer to to the [PE documentation](https://puppet.com/docs/pe/2017.3/orchestrator/running_tasks.html) or [Bolt documentation](https://puppet.com/docs/bolt/latest/bolt.html) on how to execute a task.
+
 #### Class: `apt`
 
 Main class, includes all other classes.