summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAmjith Ramanujam <amjith@newrelic.com>2014-11-30 22:27:18 -0800
committerAmjith Ramanujam <amjith@newrelic.com>2014-11-30 22:27:18 -0800
commite73e05e392ce06df8889ef3622d72870ba5f17d0 (patch)
tree070080cb71fa879333b02fe130fce752552ceed3 /README.rst
parent3d9c2b0b87ab2cf49d461dc5441d6488cccd7103 (diff)
Readme formatting.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst89
1 files changed, 44 insertions, 45 deletions
diff --git a/README.rst b/README.rst
index 2bf66a56..cff7c92a 100644
--- a/README.rst
+++ b/README.rst
@@ -6,25 +6,61 @@ This is a postgres client that does auto-completion and syntax highlighting.
.. image:: screenshots/image02.png
.. image:: screenshots/image01.png
-Installation
-============
+Quick Start
+-----------
+
+If you already know how to install python pacakges, then you can simply do:
+
+::
+
+ $ pip install pgcli
If you don't know how to install python pacakges, please check the `detailed instructions`__.
__ https://github.com/amjith/pgcli#detailed-installation-instructions
-If you already know how to install python pacakges, then you can simply do:
+Usage
+-----
-::
+::
- $ pip install pgcli
+ $ pgcli [database_name]
+
+ or
+
+ $ pgcli postgresql://[user[:password]@][netloc][:port][/dbname]
+
+Examples:
+
+::
+
+ $ pgcli local_database
+
+ $ pgcli postgres://amjith:pa$$w0rd@example.com:5432/app_db
+
+Features
+--------
+
+The `pgcli` is written using prompt_toolkit_.
+
+* Auto-completion as you type for SQL keywords as well as tables and
+ columns in the database.
+* Syntax highlighting using Pygments.
+* Smart-completion (enabled by default) will suggest context-sensitive completion.
+
+ - `SELECT * FROM <tab>` will only show table names.
+ - `SELECT * FROM users WHERE <tab>` will only show column names.
+* Config file is automatically created at ~/.pglirc at first launch.
+* Primitive support for `psql` back-slash commands.
+
+.. _prompt_toolkit: https://github.com/jonathanslenders/python-prompt-toolkit
Detailed Installation Instructions:
-===================================
+-----------------------------------
OS X:
------
+=====
For installing Python pacakges it is recommended to use the package manager
called `pip`. Check if `pip` is installed on the system.
@@ -55,7 +91,7 @@ If pip is not installed check if easy_install is available on the system.
$ sudo easy_install pgcli
Linux:
-------
+======
Check if pip is already available in your system.
@@ -86,40 +122,3 @@ Then you can install pgcli:
$ sudo pip install pgcli
-Usage
-=====
-
-::
-
- $ pgcli [database_name]
-
- or
-
- $ pgcli postgresql://[user[:password]@][netloc][:port][/dbname]
-
-Examples:
-
-::
-
- $ pgcli local_database
-
- $ pgcli postgres://amjith:pa$$w0rd@example.com:5432/app_db
-
-
-Features
-========
-
-The `pgcli` is written using prompt_toolkit_.
-
-* Auto-completion as you type for SQL keywords as well as tables and
- columns in the database.
-* Syntax highlighting using Pygments.
-* Smart-completion (enabled by default) will suggest context-sensitive completion.
-
- - `SELECT * FROM <tab>` will only show table names.
- - `SELECT * FROM users WHERE <tab>` will only show column names.
-
-* Config file is automatically created at ~/.pglirc at first launch.
-* Primitive support for `psql` back-slash commands.
-
-.. _prompt_toolkit: https://github.com/jonathanslenders/python-prompt-toolkit