1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..42f765d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# puppet-gitweb #
+
+Installs and configures gitweb
+
+## Synopsis ##
+
+    # Override the defaults, optional
+    class { "gitweb::settings":
+      site_alias => "gitweb.example.com",
+      projectroot => "/home/git/repositories",
+    }
+
+    include gitweb # magic!