Update README.md

input-output-hk · Nov 24, 2023 · 1ca3db1 · 1ca3db1
1 parent 90c5155
commit 1ca3db1
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/catalyst_voices/README.md b/catalyst_voices/README.md
@@ -2,10 +2,14 @@
 
 <!-- markdownlint-disable MD029 -->
 
+This repository contains the Catalyst Voices app and packages.
+
 * [Catalyst Voices](#catalyst-voices)
   * [Requirements](#requirements)
   * [Getting Started](#getting-started)
     * [Bootstrapping](#bootstrapping)
+    * [Packages](#packages)
+    * [Flavors](#flavors)
   * [Running Tests](#running-tests)
 
 ## Requirements
@@ -37,6 +41,20 @@ cd catalyst_voices
 melos bootstrap
 ```
 
+### Packages
+
+| Package                           | Description              | Example   |
+|-----------------------------------|--------------------------|-----------|
+| [catalyst_voices_assets]()        | Assets used in Catalyst Voices |[example]()|
+| [catalyst_voices_blocs]()         | State management of Catalyst Voices |[example]()|
+| [catalyst_voices_localization]()  | Localization files for Catalyst Voices |[example]()|
+| [catalyst_voices_models]()        | Models |[example]()|
+| [catalyst_voices_repositories]()  | Repositories |[example]()|
+| [catalyst_voices_services]()      | Services |[example]()|
+| [catalyst_voices_view_models]()   | ViewModels  |[example]()|
+
+### Flavors
+
 This project contains 3 flavors:
 
 * development