Skip to content
Browse files

Merge pull request #1 from chrisglass/documentation

Added a slightly more beautiful and complete README
  • Loading branch information...
2 parents abe7a83 + 43bf5d5 commit 4efe4c9a7c6bb48eee0d80304b7df78268a29936 @danleyden committed Dec 14, 2011
Showing with 33 additions and 7 deletions.
  1. +0 −7 README
  2. +33 −0 README.rst
View
7 README
@@ -1,7 +0,0 @@
-mdns puppet module
-
-Author: Daniel Leyden
-
-Supports the installation of avahi and publishing of services
-
-
View
33 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')
+

0 comments on commit 4efe4c9

Please sign in to comment.
Something went wrong with that request. Please try again.