Add README for Mercurial

1 files changed, 32 insertions, 0 deletions

diff --git a/README.HG.markdown b/README.HG.markdown
new file mode 100644
index 0000000..9585ea4
--- /dev/null
+++ b/README.HG.markdown
@@ -0,0 +1,32 @@
+Using vcsrepo with Mercurial
+============================
+
+To create a blank repository
+----------------------------
+
+Define a `vcsrepo` without a `source` or `revision`:
+
+    vcsrepo { "/path/to/repo":
+      ensure => present,
+      provider => hg
+    }
+
+To clone/pull & update a repository
+----------------------------
+
+To get the default branch tip:
+
+    vcsrepo { "/path/to/repo":
+        ensure => present,
+        provider => hg,
+        source => "http://hg.example.com/myrepo"
+    }
+
+For a specific changeset, use `revision`:
+
+    vcsrepo { "/path/to/repo":
+        ensure => present,
+        provider => hg,
+        source => "http://hg.example.com/myrepo"
+        revision => '21ea4598c962'
+    }