Permalink
Browse files

Some more verbose explanation on the first docs page

  • Loading branch information...
1 parent f61c62f commit 4cd8e5c86589eaea350e6cdd36fbc4a729a713a8 @dvarrazzo committed Nov 27, 2011
Showing with 19 additions and 5 deletions.
  1. +19 −5 docs/index.rst
View
@@ -1,8 +1,3 @@
-.. PGXN Client documentation master file, created by
- sphinx-quickstart on Tue May 3 00:34:03 2011.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
PGXN Client's documentation
===========================
@@ -11,6 +6,25 @@ 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.
+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/

0 comments on commit 4cd8e5c

Please sign in to comment.