From a9967e78398c76089c04a2c986bf41db687ffb96 Mon Sep 17 00:00:00 2001
From: "S.Nishio" <nishio@densan-labs.net>
Date: Thu, 13 Feb 2014 01:08:50 +0900
Subject: Update README.md

---
 README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 60 insertions(+), 11 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index a3cdbf7..bc8b10c 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,66 @@
-bitbucket-pullrequest-builder-plugin
-===================================================
+Bitbucket Pull Request Builder Plugin
+================================
 
-Bitbucket Pull Request Builder Plugin for Jenkins
+This Jenkins plugin builds pull requests from Bitbucket.org and will report the test results.
 
-Download Link
-===================================================
 
-- http://doc.densan-labs.net/bitbucket-pullrequest-builder.hpi (Temporary)
+Prerequisites
+================================
 
-TODO
-===================================================
+- Jenkins 1.509.4 or higher.
+- https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin
 
-- add readme
-- document
-- test
+Installation
+================================
 
+- Download this plugin from http://doc.densan-labs.net/bitbucket-pullrequest-builder.hpi (Temporary link)
+- Go to Jenkins -> Manage Plugins -> Advanced 
+- Choose File and select .hpi file above and upload
+- Ensure you restart Jenkins
+
+
+Creating a Job
+=================================
+
+- Create a new job
+- Select Git SCM
+- Add Repository URL as bellow
+  - git@bitbucket.org:${repositoryOwner}/${repositoryName}.git
+- In Branch Specifier, type as bellow
+  - */${sourceBranch}
+- Under Build Triggers, check Bitbucket Pull Request Builder
+- In Cron, enter crontab for this job.
+  - ex: */5 * * * *
+- In Bitbucket BasicAuth Username, write your bitbucket username like jenkins@densan-labs.net
+- In Bitbucket BasicAuth Password, write your password
+- Write RepositoryOwner
+- Write RepositoryName
+- Save to preserve your changes
+
+
+Rerun test builds
+====================
+
+If you want to rerun pull request test, write “test this please” comment to your pull request.
+
+
+
+
+Contributing to Bitbucket Pull Request Builder Plugin
+================================================
+
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+
+- Fork the project.
+
+- Start a feature/bugfix branch.
+
+- Commit and push until you are happy with your contribution.
+
+
+Copyright
+=============================
+
+Copyright © 2014 S.nishio. 
-- 
cgit v1.2.3