Skip to content
Browse files

Updating main read me and wrapping text

  • Loading branch information...
1 parent 4290b66 commit d5bb4482916d394bc506b1af161e0468e8a7b830 @mikelikespie mikelikespie committed Aug 29, 2012
Showing with 32 additions and 16 deletions.
  1. +32 −16 README.md
View
48 README.md
@@ -2,48 +2,64 @@
PonyDebugger
============
-PonyDebugger is a remote debugging toolset. It is a client library and gateway server combination that uses Chrome Developer Tools on your browser to debug your application's network traffic and managed object contexts.
+PonyDebugger is a remote debugging toolset. It is a client library and gateway
+server combination that uses Chrome Developer Tools on your browser to debug
+your application's network traffic and managed object contexts.
-To use PonyDebugger, you must implement the client in your application and connect it to the gateway server. There is currently an iOS client and the gateway server.
+To use PonyDebugger, you must implement the client in your application and
+connect it to the gateway server. There is currently an iOS client and the
+gateway server.
* [PonyDebugger iOS Client](https://github.com/square/PonyDebugger/tree/master/PonyDebugger)
* [PonyDebugger Gateway Server](https://github.com/square/PonyDebugger/tree/master/ponyd)
-PonyDebugger is licensed under the Apache Licence, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html).
+PonyDebugger is licensed under the Apache Licence, Version 2.0
+(http://www.apache.org/licenses/LICENSE-2.0.html).
Quick Start
-----------
-- First, install PonyGateway. We distributed a PyPI package for your convenience.
+```sh
-```
-sudo pip install ponygateway
+curl -sk https://cloud.github.com/downloads/square/PonyDebugger/bootstrap-ponyd.py | \
+ python - --ponyd-symlink=/usr/local/bin/ponyd ~/Library/PonyDebugger
```
- Alternatively, install in a virtualenv if you do not want to use sudo.
+This will install `ponyd` script to `~/Library/PonyDebugger/bin/ponyd` and
+attempt to symlink `/usr/local/bin/ponyd` to it. It will also download the
+latest chrome dev tools source.
-- Download Chrome Developer Tools locally using the `ponydownloader` tool. This will download Chrome Dev Tools in `~/.devtools`. Run the gateway server with `ponygateway`.
+Then start the PonyDebugger gateway server
-```
-ponydownloader
-ponygateway
+```sh
+ponyd serve --listen-interface=127.0.0.1
```
-- In your browser, navigate to `http://localhost:9000`. You should see the PonyGateway lobby. Now you need to integrate the client to your application.
+In your browser, navigate to `http://localhost:9000`. You should see the
+PonyGateway lobby. Now you need to integrate the client to your application.
-For more detailed instructions, check out the gateway server [README](https://github.com/square/PonyDebugger/blob/master/README_ponyd.rst).
+For more detailed instructions, check out the gateway server
+[README_ponyd](https://github.com/square/PonyDebugger/blob/master/README_ponyd.rst).
iOS Client Library
------------------
-Right now, integrating the iOS client requires a few steps, so you should check out the iOS Client PonyDebugger [README](https://github.com/square/PonyDebugger/blob/master/README_iOS.md#installing).
+Right now, integrating the iOS client requires a few steps, so you should check
+out the iOS Client PonyDebugger
+[README](https://github.com/square/PonyDebugger/blob/master/README_iOS.md#installing).
Contributing
------------
-Any contributors to the master PonyDebugger repository must sign the [Individual Contributor License Agreement (CLA)](https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1>). It's a short form that covers our bases and makes sure you're eligible to contribute.
+Any contributors to the master PonyDebugger repository must sign the
+[Individual Contributor License Agreement
+(CLA)](https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1>).
+It's a short form that covers our bases and makes sure you're eligible to
+contribute.
-When you have a change you'd like to see in the master repository, [send a pull request](https://github.com/square/PonyDebugger/pulls). Before we merge your request, we'll make sure you're in the list of people who have signed a CLA.
+When you have a change you'd like to see in the master repository, [send a pull
+request](https://github.com/square/PonyDebugger/pulls). Before we merge your
+request, we'll make sure you're in the list of people who have signed a CLA.
Some useful links:

0 comments on commit d5bb448

Please sign in to comment.
Something went wrong with that request. Please try again.