aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--crates/README.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/crates/README.rst b/crates/README.rst
index 8b13789..0b0860b 100644
--- a/crates/README.rst
+++ b/crates/README.rst
@@ -1 +1,36 @@
+:code:`crates`
+======
+.. list-table::
+ :widths: 25 25 25
+ :header-rows: 1
+
+ * - Name
+ - Description
+ - Version
+ * - :code:`whirl`
+ - The CLI, links everything together.
+ - :code:`0.1.0`
+ * - :code:`whirl_api`
+ - The API, for external interaction.
+ - :code:`0.1.0`
+ * - :code:`whirl_common`
+ - Assorted utilites, for global use.
+ - :code:`0.1.0`
+ * - :code:`whirl_config`
+ - Configuration utilities, to interact with the configuration system.
+ - :code:`0.1.0`
+ * - :code:`whirl_db`
+ - Database utilities, to interact with the database.
+ - :code:`0.1.0`
+ * - :code:`whirl_prompt`
+ - The Whirl Shell, for local interaction.
+ - :code:`0.1.0`
+ * - :code:`whirl_server`
+ - The meat and potatoes, exposes the Distributor and Hub for further use.
+ - :code:`0.1.0`
+
+Graph
+-----
+
+.. image:: https://raw.githubusercontent.com/Whirlsplash/whirl/develop/assets/crate_graph.svg