Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update readme format and instructions to run tests
  • Loading branch information
tommeier committed Nov 27, 2013
1 parent 0b9f1e1 commit 90c8f13
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 12 deletions.
30 changes: 20 additions & 10 deletions README.md
@@ -1,5 +1,8 @@
git-pulls
=========
#git-pulls

http://github.com/schacon/git-pulls

[![Gem Version](https://badge.fury.io/rb/comma.png)](http://badge.fury.io/rb/git-pulls)

Makes it easy to list and merge GitHub pull requests.

Expand Down Expand Up @@ -35,16 +38,14 @@ Makes it easy to list and merge GitHub pull requests.
$ git pulls merge 1
> merge pull request #1

Requirements
------------
##Requirements

`git-pulls` assumes you're using an 'origin' remote. If you are not,
either add an 'origin' remote that points to the GitHub repository you want to check
for pull requests, or set the name of your remote via an environment
variable, GIT_REMOTE.

Private repositories
--------------------
##Private repositories

To manage pull requests for your private repositories you have set up your git config for github

Expand All @@ -53,20 +54,29 @@ To manage pull requests for your private repositories you have set up your git c

You must generate your OAuth token for command line use, see how to [generate oauth token](https://help.github.com/articles/creating-an-oauth-token-for-command-line-use).

Using git-pulls with GitHub Enterprise
--------------------------------------
##Using git-pulls with GitHub Enterprise

If you want to use the git-pulls script with a private GitHub install, set the
github.host config value to your internal host.

$ git config --global github.host https://github.mycompany.com
$ git config --global github.api https://github.mycompany.com/api/v3

Installation
============
##Installation

Simply install it via Rubygems:

gem install git-pulls

(Prefix with `sudo` if necessary)

##TESTING

To run the test suite use the following command :

```Bash

bundle install
bundle exec rake test

```
2 changes: 1 addition & 1 deletion Rakefile
@@ -1,7 +1,7 @@
require "rake/testtask"

Rake::TestTask.new do |t|
t.pattern = "spec/**/*_spec.rb"
t.pattern = "spec/**/*_spec.rb"
end

task :default => :test
5 changes: 4 additions & 1 deletion git-pulls.gemspec
Expand Up @@ -18,5 +18,8 @@ Gem::Specification.new do |s|

s.add_runtime_dependency 'json'
s.add_runtime_dependency 'launchy'
s.add_runtime_dependency 'octokit'
s.add_runtime_dependency 'octokit', '~> 2.6.1'

s.add_development_dependency 'minitest'
s.add_development_dependency 'rake'
end

0 comments on commit 90c8f13

Please sign in to comment.