From 22b5b16db4d39ed6733b7b8c0c2c90156f9a4dfe Mon Sep 17 00:00:00 2001
From: Martin Schuette <info@mschuette.name>
Date: Wed, 23 Apr 2014 17:30:01 +0200
Subject: [PATCH] add usage doc

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c961525..e05ece0 100644
--- a/README.md
+++ b/README.md
@@ -16,11 +16,36 @@ design pattern.
 
 Install as a puppet module, then include with node-specific parameters.
 
+### Dependencies
+
+Install Puppet and some required modules with:
+
+```
+apt-get install puppet
+puppet module install puppetlabs-stdlib
+puppet module install puppetlabs-apt
+puppet module install puppetlabs-vcsrepo
+puppet module install saz-sudo
+puppet module install torrancew-account
+```
+
+Then add this module (which is not in the puppet forge, so it has to be
+downloaded manually):
+
+```
+cd /etc/puppet/modules
+git clone https://github.com/freifunkhamburg/puppet-ff_gw.git ff_gw
+```
+
+### Parameters
+
+Now include the module in your manifest and provide all parameters.
 Basically there are three kinds of parameters: user accounts (optional if you
 do manual user management), network config (has to be in sync with the wiki
 page), and credentials for fastd and openvpn.
 
-Example puppet code:
+
+Example puppet code (save e.g. as `/etc/puppet/gw.pp`):
 
 ```
 class { 'ff_gw':
@@ -54,3 +79,15 @@ MIIE ...
 }
 ```
 
+### Run Puppet
+
+To apply the puppet manifest (e.g. saved as `gw.pp`) run:
+
+```
+puppet apply --verbose gw.pp
+```
+
+The verbose flag is optional and shows all changes.
+To be even more catious you can also add the `--noop` flag to only show changes
+but not apply them.
+