Merge pull request #1 from chrisglass/documentation

Added a slightly more beautiful and complete README
danleyden · Dec 14, 2011 · 4efe4c9 · 4efe4c9
2 parents abe7a83 + 43bf5d5
commit 4efe4c9
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 7 deletions.
diff --git a/README b/README
diff --git a/README.rst b/README.rst
@@ -0,0 +1,33 @@
+===================
+mdns puppet module
+===================
+
+Author: Daniel Leyden
+
+Supports the installation of avahi and publishing of services
+
+
+Usage
+======
+
+Service
+-------
+To declare (expose an mdns service)::
+
+     mdns::service {
+       'myservice-%h': # %h is your hostname
+         type => '_myservice._tcp', # The mdns service type
+         port => '1234'; # The port your service is listening on
+     }
+
+.. note:: Make sure your service definition contains a unique qulifier - puppet
+          will not like having two instances with the same name
+
+Using the information
+---------------------
+
+To use (consume a service)::
+
+    # To get an array of all the services of a specific type:
+    $a_variable = get_hosts_for_mdns_service('_myservice._tcp')
+