Create index.rst

potulabe · Apr 9, 2024 · 7a8f1c8 · 7a8f1c8
1 parent 2f8ec4e
commit 7a8f1c8
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,22 @@
+Welcome to Lumache's documentation!
+===================================
+
+**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.
+
+.. note::
+
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+
+   usage
+   api