🗒️ idk docs

docs/index.rst

@@ -5,24 +5,37 @@ cfig
 The :mod:`cfig` package provides a simple but powerful configuration manager for Python applications.
 
 
+Pitch
+=====
+
+Ever had trouble making your application configurable?
+Ever fought with global objects which impeded code reuse?
+Ever had a confused user ask you how to configure your application?
+In that case, :mod:`cfig` is for you!
+
+
+Minimal example
+===============
+
+.. image:: example-definition.png
+
+.. image:: example-usage.png
+
+.. image:: example-configuration.png
+
+
 Table of contents
 =================
 
 .. toctree::
 
-    installation
     goals
+    installation
+    quickstart
     reference
     glossary
 
 
-Example
-=======
-
-If you'd like to learn how to use :mod:`cfig` hands-on, read `the source code of the cfig.sample module <https://github.com/Steffo99/cfig/tree/main/cfig/sample>`_!
-
-
-
 Other tables and links
 ======================
 

docs/installation.rst

@@ -24,14 +24,7 @@ You can install :mod:`cfig` through :mod:`pip`:
 
 .. code-block:: console
 
-    $ pip install cfig
-    Collecting cfig
-      Downloading cfig-0.2.1-py3-none-any.whl (12 kB)
-    Collecting lazy-object-proxy<2.0.0,>=1.7.1
-      Downloading lazy_object_proxy-1.7.1-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (62 kB)
-         ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.3/62.3 KB 2.3 MB/s eta 0:00:00
-    Installing collected packages: lazy-object-proxy, cfig
-    Successfully installed cfig-0.2.1 lazy-object-proxy-1.7.1
+    $ pip install cfig[cli]
 
 .. note::
 
@@ -45,18 +38,7 @@ You can install :mod:`cfig` through :mod:`poetry`:
 
 .. code-block:: console
 
-    $ poetry add cfig
-    Using version ^0.2.1 for cfig
-
-    Updating dependencies
-    Resolving dependencies... (0.3s)
-
-    Writing lock file
-
-    Package operations: 2 installs, 0 updates, 0 removals
-
-      • Installing lazy-object-proxy (1.7.1)
-      • Installing cfig (0.2.1)
+    $ poetry add cfig[cli]
 
 
 From source
@@ -73,7 +55,7 @@ Introduced with :pep:`518`, :mod:`pip` supports automatic build and installation
 .. code-block:: console
 
     $ cd cfig
-    $ pip install .
+    $ pip install .[cli]
 
 
 For development
@@ -84,7 +66,7 @@ If you want to contribute to :mod:`cfig`, you can use :mod:`poetry` to install t
 .. code-block:: console
 
     $ cd cfig
-    $ poetry install
+    $ poetry install -E cli
 
 .. hint::
 

docs/quickstart.rst

@@ -0,0 +1,27 @@
+##########
+Quickstart
+##########
+
+This page describes how to use :mod:`cfig` in an application.
+
+.. note::
+
+    This page assumes you have already `installed <installation>` :mod:`cfig`.
+
+
+Creating a configuration module
+===============================
+
+.. todo::
+
+
+Creating configurable variables
+===============================
+
+.. todo::
+
+
+Adding CLI support
+==================
+
+.. todo::