murmurs 0.1.1 → 0.1.2

data/README.md

@@ -40,11 +40,39 @@ Note, the post-receive hook installed will never block you push commits to serve
 Test Git integration
 -------------------
 
-To confirm you can post a murmur o your Mingle project from the Git server with the configurations, you can run the following command:
+If you had concerns and wanted to try out before trying out on your production Git server, you can try the followings to get the idea of how your Git server will integrate with your Mingle project. (Please install murmurs gem, and get all configurations mentioned above ready before you start)
 
-    murmurs -m https://site-name.mingle-api.thoughtworks.com/api/v2/projects/your_project/murmurs.xml -k mingle_access_key_id -s mingle_access_secure_key  "This is a test."
+Create a local git repository
+
+    cd /tmp
+    mkdir mingle_test
+    cd mingle_test
+    git init --bare
+
+Setup murmurs git integration
+
+    murmurs -a /tmp/mingle_test
+    cd /tmp/mingle_test
+    git config hooks.minglemurmursurl "https://<your-site>.mingle-api.thoughtworks.com/api/v2/projects/<your-project>/murmurs.xml"
+    git config hooks.mingleaccesskeyid <Mingle user access key id>
+    git config hooks.mingleaccesssecretkey <Mingle user access secret key>
 
-Type "murmurs -h" for full details.
+Clone a local test repository
 
+    cd /tmp
+    git clone mingle_test mingle_test_local
+
+Make an empty commit and push to origin master to trigger post-receive hook on origin repository
+
+    cd mingle_test_local
+    git commit --allow-empty -m "hello world, this is git mingle integration test"
+    git push origin master
+
+Test post a murmur on your project
+-------------------
+
+To confirm you can post a murmur to your Mingle project from the Git server with the configurations, you can run the following command:
+
+    murmurs -m https://site-name.mingle-api.thoughtworks.com/api/v2/projects/your_project/murmurs.xml -k mingle_access_key_id -s mingle_access_secure_key  "This is a test."
 
-So before you integrate Git server with your Mingle project, you can test the configurations on your Git server first, for example:
+Type "murmurs -h" for full details of the options available.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: murmurs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -27,9 +27,11 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.3
-description: ! 'Post murmur to your Mingle project from command line.
+description: ! 'Itegrate Git with your Mingle project by posting murmurs to your Mingle
+  project when new commits got pushed to Git server.
 
-  Git post-receive hook to post murmurs when new commits pushed to Git server.
+  This gem provides command to generate Git post-receive hook and post murmurs to
+  your Mingle project.
 
 '
 email:
@@ -58,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 716371937611647900
+      hash: -2214621304214247920
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -67,11 +69,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 716371937611647900
+      hash: -2214621304214247920
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Post murmur to Mingle project murmurs
+summary: Integrate Git with your Mingle project
 test_files: []