From 51412e961d41186844ec1af0cbe0d9d5bd04fb73 Mon Sep 17 00:00:00 2001
From: Saz <me@saz.sh>
Date: Sun, 20 Nov 2011 21:53:45 +0100
Subject: changes for release on forge.puppetlabs.com

---
 README.md | 30 +++++++++++++++++++-----------
 1 file changed, 19 insertions(+), 11 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 6bc2d28..ec4341e 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,31 @@
 # puppet-rsyslog
-puppet-rsyslog is a module for puppet to manage rsyslog client and server
+
+Manage rsyslog client and server via Puppet
 
 ## How to use
-```include rsyslog::client```
 
-or
+### Client
+```
+    include rsyslog::client
+```
+
+#### Using a different server
+```
+    $rsyslog_server = 'another-server'
+    include rsyslog::client
+```
 
+### Server
 ```
-    $rsyslog_server_dir = "/path/to/target/directory/"
     include rsyslog::server
 ```
 
 Both can be installed at the same time.
 
-Default server name is 'log'.
-$rsyslog_server_dir defaults to '/srv/log/'
+#### Other variables
+* $rsyslog_server_dir = '/srv/log/'
 
-### Setting a different server
-```
-    $rsyslog_server = "another.server.domain.tld"
-    include rsyslog::client
-```
+### Other notes
+
+* rsyslog::client is logging through relp
+* rsyslog::server is running relp, udp and tcp
-- 
cgit v1.2.3