doc: update readme to link the various documentation sections

README.rst

@@ -1,117 +1,44 @@
 LeanJS
 ======
 
-Yet another starter kit for Universal NodeJS applications using React, Redux,
-Webpack and Bootstrap 4.
-
+LeanJS is a clean, simple (yet featureful) opinionated NodeJS + React + Reduc starter-kit /
+boilerplate projet.
 
 .. image:: https://travis-ci.org/hartym/LeanJS.svg?branch=master
     :target: https://travis-ci.org/hartym/LeanJS
+    :alt: Continuous Integration Status
 
 
 .. image:: https://david-dm.org/hartym/LeanJS.svg
     :target: https://david-dm.org/hartym/LeanJS
+    :alt: Dependencies Status
 
 
 .. image:: https://coveralls.io/repos/github/hartym/LeanJS/badge.svg?branch=master
     :target: https://coveralls.io/github/hartym/LeanJS?branch=master
+    :alt: Coverage Status
 
 
 .. image:: https://readthedocs.org/projects/leanjs/badge/?version=latest
     :target: http://leanjs.readthedocs.org/en/latest/?badge=latest
     :alt: Documentation Status
 
+Goals
+:::::
 
-Dependencies
-::::::::::::
-
-* Babel
-* Express
-* React (15)
-* React Router
-* Redux
-* Webpack
-
-And a few glue libraries (like react-redux and react-router-redux).
-
-Tests, coverage and code style
-::::::::::::::::::::::::::::::
-
-* ESLint with "JavaScript Standard Style" and a few addons to make it behave correctly with React.
-* Istanbul
-* Karma
-* Tape
-
-Directory structure:
-
-* bin: management and instrumentation scripts.
-* build: production releases (out of version control).
-* coverage: generated coverage data (out of version control).
-* config: declarative configuration, including webpack configuration.
-* src: application(s) source code.
-* test: tests, using tape as a default.
-
-
-Install
-:::::::
-
-    npm install
-
-
-Run (development)
-:::::::::::::::::
-
-    make
-
-
-Tests and code style check
-::::::::::::::::::::::::::
-
-    make lint
-    make test
-
-
-Start hacking
-:::::::::::::
-
-An ``example`` application is provided, but do not do much for now. One good
-approach to start hacking based on this starter kit is to clone the repository,
-create a sibling directory to the example application and start coding your app
-next to the examples.
-
-It has two benefits:
-
-1. You can still look at the example while trying to understand what the fuck I
-   did in this package.
-
-2. You can contribute back to the example or general skeleton easily.
-
-Good luck. As you choosed react, you will waste a lot of time learning all the
-javascript kiddos shenanigans.
-
-
-Build (for production)
-::::::::::::::::::::::
-
-    make build
-
-
-Build (for production, using docker)
-::::::::::::::::::::::::::::::::::::
-
-    make docker-build
-
-
-Production run (using docker)
-:::::::::::::::::::::::::::::
-
-    make docker-run
+* Setup a full-featured universal NodeJS + React project fast.
+* Don't setup a hammer if you only need a screwdriver.
+* Focus on value, get to code in seconds, not hours.
 
 
-Final word
-::::::::::
+`Documentation <http://leanjs.readthedocs.org/en/latest/>`_
+:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
 
-Good luck.
+* `Getting Started <http://leanjs.readthedocs.org/en/latest/install.html>`_
+* `Features <http://leanjs.readthedocs.org/en/latest/features.html>`_
+* `Recipes <http://leanjs.readthedocs.org/en/latest/recipes.html>`_
+* `Reference <http://leanjs.readthedocs.org/en/latest/reference.html>`_
+* `Frequently Asked Questions <http://leanjs.readthedocs.org/en/latest/faq.html>`_
 
 
 ----

doc/index.rst

@@ -4,11 +4,6 @@ LeanJS
 LeanJS is a clean, simple (yet featureful) opinionated NodeJS + React + Reduc starter-kit /
 boilerplate projet.
 
-* :doc:`install`
-* :doc:`features`
-* :doc:`recipes`
-* :doc:`reference`
-
 
 Goals
 :::::
@@ -18,34 +13,21 @@ Goals
 * Focus on value, get to code in seconds, not hours.
 
 
-
-
-:doc:`recipes`
-::::::::::::::
-
-* :doc:`recipes/bootstrap`
-* :doc:`recipes/font-awesome`
-
-
-Miscellaneous
+Documentation
 :::::::::::::
 
-* :doc:`faq`
-
-
-
 .. toctree::
     :maxdepth: 2
 
     install
     features
     recipes
     reference
-
+    faq
 
 
 Indices and tables
-==================
+::::::::::::::::::
 
 * :ref:`genindex`
 * :ref:`search`

doc/reference.rst

@@ -1,4 +1,14 @@
 Reference
 =========
 
+Directory structure:
 
+* bin: management and instrumentation scripts.
+* build: production releases (out of version control).
+* coverage: generated coverage data (out of version control).
+* config: declarative configuration, including webpack configuration.
+* src: application(s) source code.
+* test: tests, using tape as a default.
+
+
+(TODO: this is a work in progress, reference is lacking a lot of sections as of now).