From 0fb6eb9d33b6e5facb273c530d982ad98334b42c Mon Sep 17 00:00:00 2001
From: Gustavo Furtado <gustavofurtado2@gmail.com>
Date: Tue, 15 Mar 2022 13:59:07 -0300
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20README.md=20files?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md                           | 20 ++++++++-----
 dash_charlotte/components/README.md |  8 +++++
 dash_charlotte/themes/README.md     | 45 +++++++++++++++++++++++++++++
 3 files changed, 65 insertions(+), 8 deletions(-)
 create mode 100644 dash_charlotte/components/README.md
 create mode 100644 dash_charlotte/themes/README.md

diff --git a/README.md b/README.md
index 648f63f..1795822 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,31 @@
 # Dash Charlotte
 
-A package of themes, tools and components that I use on my Plotly-Dash web applications.
+A package of themes, tools and components that I use on my Plotly-Dash web dashboards.
 
 This is still a super early work in progress and probably not very interesting, so don't waste your time here.
 
 ## Submodules
 
-- **Components**
+- [**Components**](https://github.com/GusFurtado/dash-charlotte/tree/main/dash_charlotte/components)
 
-Some Dash components for fast dashboard building.
+A set of standard Dash components for a fast and modular dashboard building.
 
-- **Themes**
+- [**Themes**](https://github.com/GusFurtado/dash-charlotte/tree/main/dash_charlotte/themes)
 
-Colors, fonts, icon packages and CSS stuff.
+Tools for easy and consistent styling. Colors, fonts, icon packages and CSS stuff.
 
-- **Layouts**
+- [**Layouts**](https://github.com/GusFurtado/dash-charlotte/tree/main/dash_charlotte/layouts)
 
 Some pre-built page layouts.
 
 ## Instatlation
 
-By `pip` in a near future.
+- `pip install dash-charlotte`
 
 ## License
 
-- [MIT]([LICENSE])
\ No newline at end of file
+- [**MIT**]([LICENSE])
+
+## Getting Started
+
+Check the [example app](https://github.com/GusFurtado/dash-charlotte/blob/main/example_app.py).
diff --git a/dash_charlotte/components/README.md b/dash_charlotte/components/README.md
new file mode 100644
index 0000000..a39c273
--- /dev/null
+++ b/dash_charlotte/components/README.md
@@ -0,0 +1,8 @@
+# Dash Charlotte Components
+
+A set of standard Dash components for a fast and modular dashboard building.
+
+- [**Box**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/components/box.py)
+- [**Dashboard**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/components/dashboard.py)
+- [**Drawer**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/components/drawer.py)
+- [**Navbar**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/components/navbar.py)
\ No newline at end of file
diff --git a/dash_charlotte/themes/README.md b/dash_charlotte/themes/README.md
new file mode 100644
index 0000000..2785179
--- /dev/null
+++ b/dash_charlotte/themes/README.md
@@ -0,0 +1,45 @@
+# Dash Charlotte Themes
+
+Tools for easy and consistent styling.
+
+Add them in Dash's `external_stylesheet` argument:
+
+```python
+from dash import Dash
+import dash_labs as dl
+import dash_bootstrap_components as dbc
+
+from dash_charlotte import themes
+
+app = Dash(
+    name = __name__,
+    title = 'Dash Charlotte',
+    plugins = [dl.plugins.pages],
+    external_stylesheets = [
+        dbc.themes.BOOTSTRAP,
+        themes.BOOTSTRAP,
+        themes.BOXICONS,
+        themes.FONTAWESOME,
+        themes.CHARLOTTE_LIGHT
+    ]
+)
+```
+
+---
+
+- Colors
+    - [**Bootstrap**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/bootstrap.py)
+    - [**Charlotte Dark**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/charlotte_dark.py)
+    - [**Charlotte Light**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/charlotte_light.py)
+    - [**Colorblind**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/colorblind.py)
+    - [**Dracula**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/dracula.py)
+- [**Fonts**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/fonts.py)
+    - Fire Code
+    - Montserrat
+    - Nunito
+    - Poppins
+    - Roboto
+- [**Icons**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/icons.py)
+    - Bootstrap Icons
+    - Boxicons
+    - FontAwesome
\ No newline at end of file