Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Pull Request Closes #35: Improve README.md.

  • Loading branch information...
commit e10e5f971c7229125ef6c7fb99a0c4a1de71290e 1 parent 2c3d410
@sindresorhus sindresorhus authored mikesherov committed
Showing with 35 additions and 26 deletions.
  1. +35 −26 README.md
View
61 README.md
@@ -1,43 +1,52 @@
-Pulley: An Easy Github Pull Request Lander
-==========================================
+# Pulley
-Landing a pull request from Github can be messy. You can push the merge button but that'll result in a messy commit stream and external ticket trackers that don't automatically close tickets.
+### An Easy Github Pull Request Lander
+
+
+## Introduction
+
+Landing a pull request from Github can be messy. You can push the merge button, but that'll result in a messy commit stream and external ticket trackers that don't automatically close tickets.
Additionally you can pull the code and squash it down into a single commit, which lets you format the commit nicely (closing tickets on external trackers) - but it fails to properly close the pull request.
-Pulley is a tool that uses the best aspects of both techniques. Pull requests are pulled and merged into your project. The code is then squashed down into a single commit and nicely formatted with appropriate bug numbers and links. Finally the commit is pushed and the pull request is closed with a link to the commit.
+Pulley is a tool that uses the best aspects of both techniques. Pull requests are pulled and merged into your project. The code is then squashed down into a single commit and nicely formatted with appropriate bug numbers and links. Finally the commit is pushed and the pull request is closed with a reference to the commit.
+
+
+## Getting Started
+
+
+### Install
+
+Make sure you have [Node.js](http://nodejs.org/#download) and then run `npm install -g pulley` in Terminal.
+
-Pulley is written using Node.js - thus you'll need to make sure that you have Node installed prior to running it.
+### Use
-How To Use
--------------
+Open the target repo in Terminal and run `pulley PID`, where PID is the Pull Request ID.
-Start by configuring the details in the config.json file. Once that's complete you can run the following command:
- node pulley.js PID # Where PID is the Pull Request ID
+### Example
-For example running the command `node pulley.js 332` on the jQuery repo yielded the following closed pull request and commit:
+Running `pulley 332` on the jQuery repo yielded the following closed [pull request](https://github.com/jquery/jquery/pull/332) and [commit](https://github.com/jquery/jquery/commit/d274b7b9f7727e8bccd6906d954e4dc790404d23).
-- https://github.com/jquery/jquery/pull/332
-- https://github.com/jquery/jquery/commit/d274b7b9f7727e8bccd6906d954e4dc790404d23
-How To Contribute and Test
---------------------------
+## Contribute and Test
-In order to test your improvements to pulley, you need a few things:
+In order to test your changes to pulley, you need the ability to:
-1. The ability to open and close pull requests.
-2. The ability to push to a branch on a repo.
+- Open and close pull requests
+- Push to a branch on a repo
-Essentially, you need your own repo, and the ability to issue pull requests against that repo. Fortunately, github allows you to issue pull requests against your own repo from one branch to another. Here are the steps:
+Essentially, you need your own repo, and the ability to issue pull requests against that repo. Fortunately, GitHub allows you to issue pull requests against your own repo from one branch to another. Here are the steps:
-1. Fork pulley.
-2. checkout the `test` branch.
-3. branch off from the `test` branch to another branch named `test-1`.
-4. create a commit on the `test-1` branch.
-5. push the commit to the `test-1` branch on your fork of pulley.
-6. Open a pull request from `test-1` to `test` *on your own repo*.
-7. Use pulley to merge your pull request, and ensure everything went smoothly.
-8. Submit your real pull request with your changes.
+1. Fork pulley
+2. Checkout the `test` branch
+3. Branch off from the `test` branch to another branch named `test-1`
+4. Create a commit on the `test-1` branch
+5. Publish the `test-1` branch
+6. Push the commit to the `test-1` branch on your fork of pulley
+7. Open a pull request from `test-1` to `test` *on your own repo*
+8. Use pulley to merge your pull request, and ensure everything went smoothly
+9. Submit your real pull request with your changes
Please lend a hand!
Please sign in to comment.
Something went wrong with that request. Please try again.