Updated package metadata

--HG--
branch : web

Author: Lukasz Balcerzak

README.rst

@@ -2,10 +2,48 @@
 VCS
 ===
 
-Various Version Control System management abstraction layer for Python.
+various version control system management abstraction layer for python.
 
+------------
 Introduction
 ------------
 
-TODO: To be written...
+``vcs`` is abstraction layer over various version control systems. It is
+designed as feature-rich Python_ library with clean *API*. 
+
+.. warning::
+   This library is at early-development *ALPHA* stage.
+
+.. note::
+   Currently only Mercurial_ backend is being developed. Git_ is going to be
+   second backend.
+
+**Features**
+
+- Common *API* for SCM backends
+
+**Incoming**
+
+- Django_ app for mercurial_ hgserve replacement
+- Command line client
+
+-------------
+Documentation
+-------------
+
+Online documentation for development version is available at
+http://packages.python.org/vcs/.
+
+You may also build documentation for yourself - go into ``docs/`` and run::
+
+   make html
+
+.. note::
+   In order to build documentation you would need Sphinx_.
+
+.. _python: http://www.python.org/
+.. _Django: http://www.djangoproject.com/
+.. _Sphinx: http://sphinx.pocoo.org/
+.. _mercurial: http://mercurial.selenic.com/
+.. _git: http://git-scm.com/
 

docs/quickstart.rst

@@ -37,7 +37,7 @@ There is no need to import everything from ``vcs`` - in fact, all you'd need is
 to import ``get_repo``, at least for now. Then, simply initialize repository
 object by providing it's type and path.
 
-.. code-block:: python
+.. code-block:: pycon
 
    >>> from vcs import get_repo
    >>>

examples/django_simplehgwiki/hgwiki/models.py

@@ -11,6 +11,7 @@ class Wiki(models.Model):
     slug = models.SlugField(unique=True)
     repository = models.ForeignKey(Repository)
     content = models.TextField(default='')
+    #private = models.BooleanField(default=True)
 
     class Meta:
         ordering = ('title',)

setup.cfg

@@ -0,0 +1,8 @@
+[build_sphinx]
+source-dir = docs/
+build-dir  = docs/build
+all_files  = 1
+
+[upload_sphinx]
+upload-dir = docs/build/html
+

setup.py

@@ -16,7 +16,7 @@
     version = VERSION,
     url = 'http://bitbucket.org/marcinkuzminski/vcs/',
     author = 'Marcin Kuzminski, Lukasz Balcerzak',
-    author_email = 'marcinkuzminski@gmail.com',
+    author_email = 'marcin@python-blog.com',
     description = vcs.__doc__,
     long_description = long_description,
     zip_safe = False,