Updated to rst for README and added contributor

Thanks to johnpaulett for the .gitignore file.

Github rst rendering has improved so switching back to that.

README.rst

@@ -1,4 +1,5 @@
-# Sphinx to GitHub
+Sphinx to GitHub
+================
 
 A Python script for preparing the html output of the Sphinx documentation
 system for github pages.
@@ -6,75 +7,86 @@ system for github pages.
 It renames any top level folders which start with an underscore and edits any
 references to them within the html files.
 
-### Why?
+Why?
+----
 
 GitHub processes the incoming html with Jekyll which believes top level folders
 starting with an underscore are special and does not let their content be accessible
 to the server. This is incompatible with Sphinx which uses underscores at the
 start of folder names for static content.
 
-## Usage
+Usage
+-----
 
 The ``sphinxtogithub.py`` script can be run on the command line or used as a
 Sphinx extension.
 
-### Extension
+Extension
+~~~~~~~~~
 
 Place the script on the ``PYTHONPATH`` and add ``sphinxtogithub`` to the
-extensions list in the ``conf.py`` file in your Sphinx project:
+extensions list in the ``conf.py`` file in your Sphinx project::
 
     extensions = [ "sphinxtogithub" ]
 
 Additionally there are two config variables you can use to control the
 extension. The first enables/disables the extension and the second enables
-verbose output. They are ``True`` by default:
+verbose output. They are ``True`` by default::
 
     sphinx_to_github = True
     sphinx_to_github_verbose = True
 
-### Command Line
+Command Line
+~~~~~~~~~~~~
 
 Run the script with the path to the ``html`` output directory as the first
 argument. There is a ``--verbose`` flag for basic output.
 
-## Further Information
+Further Information
+-------------------
 
-### Install from GitHub
+Install from GitHub
+~~~~~~~~~~~~~~~~~~~
 
-It should be possible to install this tool directly from github using pip:
+It should be possible to install this tool directly from github using pip::
 
     pip install -e git+git://github.com/michaeljones/sphinx-to-github.git#egg=sphinx-to-github
 
-Thanks to [winhamwr's](http://github.com/winhamwr) work.
+Thanks to `winhamwr <http://github.com/winhamwr>`_'s work.
 
-### Requirements
+Requirements
+~~~~~~~~~~~~
 
 The script uses ``/usr/bin/env`` and ``python``.
 
-### Running Tests
+Running Tests
+~~~~~~~~~~~~~
 
-Unit tests can be run using the setuptools ``test`` target. eg:
+Unit tests can be run using the setuptools ``test`` target. eg::
 
     $ python setup.py test
 
-### Alternatives
+Alternatives
+~~~~~~~~~~~~
 
-[dinoboff's](http://github.com/dinoboff) project
-[github-tools](http://github.com/dinoboff/github-tools) provides similar
+`dinoboff <http://github.com/dinoboff>`_'s project
+`github-tools <http://github.com/dinoboff/github-tools>`_ provides similar
 functionality combined with a much more comprehensive set of tools for helping
 you to manage Python based projects on github.
 
-## Credits
+Credits
+-------
 
 Thank you to:
 
-* [mikejs](http://github.com/mikejs)
-* [certik](http://github.com/certik)
-* [davvid](http://github.com/davvid)
-* [winhamwr](http://github.com/winhamwr)
+* `mikejs <http://github.com/mikejs>`_
+* `certik <http://github.com/certik>`_
+* `davvid <http://github.com/davvid>`_
+* `winhamwr <http://github.com/winhamwr>`_
+* `johnpaulett <http://github.com/johnpaulett>`_
 
 For their contributions, which are beginning to outweigh mine, to Georg Brandl
-for [Sphinx](http://sphinx.pocoo.org/) and the github crew for the pages
+for `Sphinx <http://sphinx.pocoo.org/>`_ and the github crew for the pages
 functionality.