summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAmjith Ramanujam <amjith@newrelic.com>2014-12-19 00:32:26 -0800
committerAmjith Ramanujam <amjith@newrelic.com>2014-12-19 00:32:26 -0800
commitf87a71f511dc5653c25964128666a8d808f86b35 (patch)
treea8298abf734ca1396ec27d6277d1eecf294fb034
parent8bd1d9dd7e2f33aed255c607efab6a2daf55fc92 (diff)
Update readme and develop docs.
-rw-r--r--DEVELOP.rst4
-rw-r--r--README.rst14
2 files changed, 15 insertions, 3 deletions
diff --git a/DEVELOP.rst b/DEVELOP.rst
index 85280a37..07d8e767 100644
--- a/DEVELOP.rst
+++ b/DEVELOP.rst
@@ -18,7 +18,7 @@ In order to keep your fork up to date with any changes from mainline, add a new
git remote to your local copy called 'upstream' and point it to the main pgcli
repo.
-.. ::
+::
$ git remote add upstream git@github.com:amjith/pgcli.git
@@ -42,7 +42,7 @@ Create a virtualenv (let's call it pgcli-dev). Once the virtualenv is activated
`cd` into the local clone of pgcli folder and install pgcli using pip as
follows:
-.. ::
+::
$ pip install --editable .
diff --git a/README.rst b/README.rst
index 436849bf..1737f395 100644
--- a/README.rst
+++ b/README.rst
@@ -58,6 +58,18 @@ The `pgcli` is written using prompt_toolkit_.
.. _prompt_toolkit: https://github.com/jonathanslenders/python-prompt-toolkit
+Contributions:
+--------------
+
+If you're interested in contributing to this project, first of all I would like
+to extend my heartfelt gratitude. I've written a small doc to describe how to
+get this running in a development setup.
+
+https://github.com/amjith/pgcli/blob/master/DEVELOP.rst
+
+Please feel free to reach out to me if you need help.
+My email: amjith.r@gmail.com, Twitter: `@amjithr <http://twitter.com/amjithr>`_
+
Detailed Installation Instructions:
-----------------------------------
@@ -126,7 +138,7 @@ Then you can install pgcli:
Thanks:
-=======
+-------
A special thanks to `Jonathan Slenders <https://twitter.com/jonathan_s>`_ for
creating `Python Prompt Toolkit <http://github.com/jonathanslenders/python-prompt-toolkit>`_,