From 2f943ab09088bdbd8a827d232c5dd9b176f9594f Mon Sep 17 00:00:00 2001
From: Lorin Hochstein <lorin@isi.edu>
Date: Thu, 13 Oct 2011 14:58:54 -0400
Subject: [PATCH] Updated docs to describe setup

Change-Id: Idf7c543c3056b656858ef177e214aaf85b67766e
---
 README    | 38 --------------------------------------
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+), 38 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 9acb007..0000000
--- a/README
+++ /dev/null
@@ -1,38 +0,0 @@
-# git-review: A git command for submitting branches to Gerrit
-
-git-review is a tool that helps submitting git branches to gerrit for review
-
-# Assumptions
-
-git-review, by default, looks for a git remote called gerrit, and submits
-the current branch to HEAD:refs/for/master at that remote.
-
-# Usage
-
-Hack on some code, then:
-
-  git review
-
-If you want to submit that code to a different target branch, then:
-
-  git review branchname
-
-If you want to submit to a different remote:
-
-  git review -r my-remote
-
-If you want to supply a review topic:
-
-  git review -t topic/awesome-feature
-
-If you want to submit your change to a branch other than master:
-
-  git review milestone-proposed
-
-If you want to skip the automatic rebase -i step:
-
-  git review -R
-
-If you want to download change 781 from gerrit to review it:
-
-  git review -d 781
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c9bffc8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# git-review
+
+A git command for submitting branches to Gerrit
+
+git-review is a tool that helps submitting git branches to gerrit for review
+
+## Setup
+
+git-review, by default, looks for a git remote called gerrit, and submits the current branch to HEAD:refs/for/master at that remote.
+
+For example, to set it to the OpenStack Compute (nova) project (assuming you have previously signed in to the [OpenStack Gerrit server](https://review.openstack.org) with your Launchpad account), you would do:
+
+    USERNAME=jsmith # Launchpad username here
+    PROJECT=openstack/nova
+    git remote add gerrit ssh://$USERNAME@review.openstack.org:29418/$PROJECT.git
+
+
+## Usage
+
+Hack on some code, then:
+
+    git review
+
+If you want to submit that code to a different target branch, then:
+
+    git review branchname
+
+If you want to submit to a different remote:
+
+    git review -r my-remote
+
+If you want to supply a review topic:
+
+    git review -t topic/awesome-feature
+
+If you want to submit your change to a branch other than master:
+
+    git review milestone-proposed
+
+If you want to skip the automatic rebase -i step:
+
+    git review -R
+
+If you want to download change 781 from gerrit to review it:
+
+    git review -d 781