move most of text from docs/index.rst to README.rst so its also visib…

…le on PyPI and GitHub

Makefile

@@ -17,7 +17,7 @@ htmlcov/index.html: src/plone/api/*.py bin/coverage
 
 docs: docs/html/index.html
 
-docs/html/index.html: docs/*.rst docs/contribute/*.rst docs/api/*.rst src/plone/api/*.py bin/sphinx-build
+docs/html/index.html: README.rst docs/*.rst docs/contribute/*.rst docs/api/*.rst src/plone/api/*.py bin/sphinx-build
 	bin/sphinx-build -W docs docs/html
 	@touch $@
 	@echo "Documentation was generated at '$@'."

README.rst

@@ -1,2 +1,45 @@
-Please read the full documentation at
-`ReadTheDocs <http://ploneapi.readthedocs.org/>`_.
+***********
+A Plone API
+***********
+
+.. topic:: Overview
+
+    The ``plone.api`` is an elegant and simple API, built for humans wishing
+    to develop with Plone.
+
+    It comes with *cookbook*-like documentation and step-by-step instructions
+    for doing common development tasks in Plone. Recipes try to assume the user
+    does not have extensive knowledge about Plone internals.
+
+.. raw:: html
+
+    <img src="http://travis-ci.org/plone/plone.api.png?&branch=master">
+    <img src="http://coveralls.io/repos/plone/plone.api/badge.png">
+
+* `Documentation @ api.plone.org <http://api.plone.org>`_
+* `Source code @ GitHub <http://github.com/plone/plone.api>`_
+* `Issues @ GitHub <http://github.com/plone/plone.api/issues>`_
+* `Continuous Integration @ Travis CI <http://travis-ci.org/plone/plone.api>`_
+* `Code Coverage @ Coveralls.io <http://coveralls.io/r/plone/plone.api>`_
+
+The intention of this package is to be transitional. It points out the parts of
+Plone which are particularly nasty -- we hope they will get fixed so that we
+can deprecate the ``plone.api`` methods that cover them up, but the
+documentation can still be useful.
+
+Some parts of the documentation already are this way: they don't use
+``plone.api`` methods directly, but simply provide guidance on achieving a task
+using Plone's internals. Example: usage of the catalog in `Find content`
+example.
+
+The intention is to cover 20% of the tasks we do 80% of the time. Keeping
+everything in one place helps keep the API introspectable and discoverable,
+which are important aspects of being Pythonic.
+
+.. note::
+
+    This package is still under development, but should be fairly stable and is
+    already being used in production. It's currently a release candidate,
+    meaning that we don't intend to change method signatures, but it may still
+    happen.
+

docs/index.rst

@@ -4,40 +4,7 @@
     http://ploneapi.readthedocs.org/en/latest/index.html so you have working
     references and proper formatting.
 
-
-*******************************
-A Plone API
-*******************************
-
-.. topic:: Overview
-
-    The :mod:`plone.api` is an elegant and simple API, built for humans wishing
-    to develop with Plone.
-
-    It comes with *cookbook*-like documentation and step-by-step instructions
-    for doing common development tasks in Plone. Recipes try to assume the user
-    does not have extensive knowledge about Plone internals.
-
-The intention of this package is to be transitional. It points out the parts of
-Plone which are particularly nasty -- we hope they will get fixed so that we
-can deprecate the :mod:`plone.api` methods that cover them up, but the documentation
-can still be useful.
-
-Some parts of the documentation already are this way: they don't use
-:mod:`plone.api` methods directly, but simply provide guidance on achieving a task
-using Plone's internals. Example: usage of the catalog in
-:ref:`content_find_example`.
-
-The intention is to cover 20% of the tasks we do 80% of the time. Keeping
-everything in one place helps keep the API introspectable and discoverable,
-which are important aspects of being Pythonic.
-
-.. note::
-
-    This package is still under development, but should be fairly stable and is
-    already being used in production. It's currently a release candidate,
-    meaning that we don't intend to change method signatures, but it may still
-    happen.
+.. include:: ../README.rst
 
 
 Narrative documentation
@@ -69,8 +36,8 @@ Complete API and advanced usage
     api/exceptions.rst
 
 
-Contributing
-============
+Contribute
+==========
 
 .. toctree::
     :maxdepth: 2