Add components documentation

Author: steevanb

README.md

@@ -0,0 +1,3 @@
+## php-pp/readthedocs
+
+Repository for the documentation oh PHP++ available at [phppp.readthedocs.io](https://phppp.readthedocs.io/).

README.rst

@@ -0,0 +1,45 @@
+Components
+==========
+
+PHP++ id a set of reusable components. You can use all of them of just the one you need.
+
+``-contracts`` components
+-------------------------
+
+When it's possible, a component has it's counterpart ``-contract`` with only interfaces.
+
+If you don't need to use our implementation of this interfaces
+(you just need a typehint, you want to create your own implementation etc),
+add the ``-contract`` dependency and work with interfaces.
+
+Example:
+.. code-block:: php
+    :emphasize-lines: 3
+    // You need a StringCollection to work with it,
+    // don't use StringCollection but StringCollectionInterface
+    function foo(StringCollectionInterface $strings): void
+    {
+        // Do some stuff here with $strings
+    }
+
+Components
+----------
+
++----------------------+--------------------------------------------+--------------------------------------------------------------+
+| Component            | Description                                | Github                                                       |
++======================+============================================+========+=====================================================+
+| collection           | Replace array by a strict typed collection | `github.com<https://github.com/php-pp/collection>`           |
++----------------------+--------------------------------------------+--------------------------------------------------------------+
+| collection-contracts | Contracts for collection                   | `github.com<https://github.com/php-pp/collection-contracts>` |
++----------------------+--------------------------------------------+--------------------------------------------------------------+
+| collection-generator | Helps you to generate a Collection         | `github.com<https://github.com/php-pp/collection-generator>` |
++----------------------+--------------------------------------------+--------------------------------------------------------------+
+
+Development components
+----------------------
+
++----------------------+--------------------------------------------+--------------------------------------------------------------+
+| Component            | Description                                | Github                                                       |
++======================+============================================+========+=====================================================+
+| code-sniffer         | Code sniffer for PHP++ code style          | `github.com<https://github.com/php-pp/code-sniffer>`         |
++----------------------+--------------------------------------------+--------------------------------------------------------------+

docs/source/components.rst

@@ -1,29 +1,25 @@
 Welcome to PHP++ documentation!
 ===============================
 
-[PHP++](https://github.com/php-pp) is a PHP library with this behaviors:
- * Work with objects, do not use old functions (example: ``fileatime()`` -> ``FileUtils::getAccessedAt()``)
+`PHP++<https://github.com/php-pp>` is a PHP library with this features:
+ * Install only what you need: PHP++ is a set of reusable components
+ * Work with objects, do not use functions (example: ``fileatime()`` -> ``FileUtils::getAccessedAt()``)
  * Do not care about ``E_NOTICE`` and it's friends, all PHP errors are catched and replaced by an exception
- * Replace ``array`` by ``Collection`` with only one type allowed (example: ``StringCollection``, ``DateTimeNullableCollection``)
+ * Replace ``array`` by ``Collection`` with only one type allowed (example: ``StringCollection``)
 
-Compatibles PHP versions: from 7.4 to the latest.
-
-**Lumache** (/lu'make/) is a Python library for cooks and food lovers
-that creates recipes mixing random ingredients.
-It pulls data from the `Open Food Facts database <https://world.openfoodfacts.org/>`_
-and offers a *simple* and *intuitive* API.
-
-Check out the :doc:`usage` section for further information, including
-how to :ref:`installation` the project.
+Compatibles PHP versions: from ``7.4`` to the ``latest``.
 
 .. note::
 
    This project is under active development.
 
-Contents
---------
+Components
+----------
+
+`See the list of components.</components>`
 
-.. toctree::
+Issues
+------
 
-   usage
-   api
+If you find an issue, go to `github.com/php-pp<https://github.com/php-pp>`, select the component that has a problem
+and create a ticket in the ``Issue`` tab.