helpful directions

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..cc44499
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+The monkeysphere puppet module is designed to help you manage your servers
+using the monkeysphere[0].
+
+Example usage:
+
+  # assuming you are using the sshd puppet module...
+  $sshd_authorized_keys_file = "/var/lib/monkeysphere/authorized_keys/%u"
+  include sshd
+
+  # import the generated ssh key into the server's gpg ring
+  include monkeysphere::import_key
+
+  # add host names to the array below if you do not want them published to the
+  # web of trust
+  $monkeysphere_no_publish = [ "animal.mayfirst.org", "test.mayfirst.org" ]
+  include monkeysphere::publish_key
+
+  # add the fingerprints of the gpgids that should be certifiers
+  monkeysphere::add_certifiers { dkg:
+         keyid => "0EE5BE979282D80B9F7540F1CCD2ED94D21739E9" 
+  }
+  monkeysphere::add_certifiers { jamie:
+         keyid => "1CB57C59F2F42470238F53ABBB0B7EE15F2E4935" 
+  }
+
+  # add a authorized_user_ids file for the root user
+  monkeysphere::root_authorized_user_ids { main:
+         file => "puppet:///files/monkeysphere/root/authorized_user_ids" 
+  } 
+
+0. http://monkeysphere.info/