Working Bazaar support & docs

1 files changed, 38 insertions, 0 deletions

diff --git a/README.BZR.markdown b/README.BZR.markdown
new file mode 100644
index 0000000..a7494db
--- /dev/null
+++ b/README.BZR.markdown
@@ -0,0 +1,38 @@
+Using vcsrepo with Bazaar
+=========================
+
+To create a blank repository
+----------------------------
+
+Define a `vcsrepo` without a `source` or `revision`:
+
+    vcsrepo { "/path/to/repo":
+      ensure   => present,
+      provider => bzr
+    }
+
+To branch from an existing repository
+-------------------------------------:
+
+Provide the `source` location:
+
+    vcsrepo { "/path/to/repo":
+        ensure   => present,
+        provider => bzr,
+        source   => 'lp:myproj'
+    }
+
+For a specific revision, use `revision` with a valid revisionspec
+(see `bzr help revisionspec` for more information on formatting a revision):
+
+    vcsrepo { "/path/to/repo":
+        ensure   => present,
+        provider => bzr,
+        source   => 'lp:myproj',
+        revision => 'menesis@pov.lt-20100309191856-4wmfqzc803fj300x'
+    }
+
+More Examples
+-------------
+
+For examples you can run, see `examples/bzr/`