Clean up readme

README.rst

@@ -8,12 +8,17 @@ Sphinx AutoAPI
 .. image:: https://travis-ci.org/rtfd/sphinx-autoapi.svg?branch=master
    :target: https://travis-ci.org/rtfd/sphinx-autoapi
 
+.. warning:: This is a pre-release version. Some or all features might not work yet.
 
-A tool that generates a full API ref (Javadoc style) for your project.
-
-It aims to be easy to use,
+Sphinx AutoAPI aims to provide "autodoc" or "javadoc" style documentation for Sphinx.
+The aim is to support all programming languages,
+be easy to use,
 and not require much configuration.
 
+AutoAPI is a parse-only solution for both static and dynamic languages.
+This is in contract to the traditional `Sphinx autodoc <http://sphinx-doc.org/ext/autodoc.html>`_,
+which is Python-only and uses code imports.
+
 Full documentation can be found on `Read the Docs <http://sphinx-autoapi.readthedocs.org>`_.
 
 Contents
@@ -35,9 +40,23 @@ Contents
 
    autoapi/index
 
+Basic Workflow
+--------------
+
+Sphinx AutoAPI has the following structure:
+
+* Configure directory to look for source files
+* Generate JSON from those source files
+* Map the JSON into standard AutoAPI Python objects
+* Generate RST through Jinja2 templates from those Python objects
+
+This basic framework should be easy to implement in your language of choice.
+All you need to do is be able to generate a JSON structure that includes your API and docs for those classes, functions, etc.
+
 Install
 -------
 
+
 First you need to install autoapi:
 
 .. code:: bash
@@ -74,7 +93,6 @@ All of the pages that AutoAPI generates are templated with Jinja2 templates.
 You can fully customize how pages are displayed on a per-object basis.
 Read more about it in :doc:`templates`.
 
-
 Design
 ------
 
@@ -85,12 +103,12 @@ Currently Implemented
 
 * Python
 * .Net
+* Go
+* Javascript
 
 Future
 ------
-Our goal is to support the following soon:
 
-* Javascript
-* PHP
-* Python
-* Go
+Our goal is to support all languages.
+Implementation is quite simple,
+we'll be adding more docs on implementation soon.