Skip to content
Browse files

Adding some flesh to the README

Of course the best moment to remember about doing this is right after
releasing.

Renamed to allow rendering by GitHub.
  • Loading branch information...
1 parent d58a69f commit f97b126c1960195e41bc65e25fb2d34ec2d7de63 @dvarrazzo committed Nov 27, 2011
Showing with 38 additions and 3 deletions.
  1. +0 −1 README
  2. +36 −0 README.rst
  3. +2 −2 docs/index.rst
View
1 README
@@ -1 +0,0 @@
-A command line tool to interact with the PostgreSQL Extension Network.
View
36 README.rst
@@ -0,0 +1,36 @@
+=====================================================================
+ PGXN Client
+=====================================================================
+A command line tool to interact with the PostgreSQL Extension Network
+=====================================================================
+
+The `PGXN Client <http://pgxnclient.projects.postgresql.org/>`__ is a command
+line tool designed to interact with the `PostgreSQL Extension Network
+<http://pgxn.org/>`__ allowing searching, compiling, installing, and removing
+extensions in PostgreSQL databases.
+
+For example, to install the semver_ extension, the client can be invoked as::
+
+ $ pgxn install semver
+
+which would download and compile the extension for one of the PostgreSQL
+servers hosted on the machine and::
+
+ $ pgxn load -d somedb semver
+
+which would load the extension in one of the databases of the server.
+
+The client interacts with the PGXN web service and a ``Makefile`` provided by
+the extension. The best results are achieved with makefiles using the
+PostgreSQL `Extension Building Infrastructure`__; however the client tries to
+degrade gracefully in presence of any package hosted on PGXN.
+
+.. _semver: http://pgxn.org/dist/semver
+.. __: http://www.postgresql.org/docs/9.1/static/extend-pgxs.html
+
+- Home page: http://pgxnclient.projects.postgresql.org/
+- Downloads: http://pypi.python.org/pypi/pgxnclient/
+- Discussion group: http://groups.google.com/group/pgxn-users/
+- Source repository: https://github.com/dvarrazzo/pgxnclient/
+- PgFoundry project: http://pgfoundry.org/projects/pgxnclient/
+
View
4 docs/index.rst
@@ -3,8 +3,8 @@ PGXN Client's documentation
The `PGXN Client <http://pgxnclient.projects.postgresql.org/>`__ is a command
line tool designed to interact with the `PostgreSQL Extension Network
-<http://pgxn.org/>`__ allowing searching, compiling, installing and removing
-extensions in a PostgreSQL installation or database.
+<http://pgxn.org/>`__ allowing searching, compiling, installing, and removing
+extensions in PostgreSQL databases.
For example, to install the semver_ extension, the client can be invoked as::

0 comments on commit f97b126

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