aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2022-05-24 19:35:12 +0200
committerGitHub <noreply@github.com>2022-05-24 19:35:12 +0200
commitc85ab5ad43ccf52881ee224672c41ec30021cf48 (patch)
tree8058808d9bfca19383f120c46b34d99ff2f89f63 /README.md
parent52404177c07a2aab7fc894362fb3060dff2431a0 (diff)
parent11b9de44a4b2f305a6a484187805e429b2767118 (diff)
refactor: use storybook and atomic design (#16)
BREAKING CHANGE: rewrite most of the Typescript types, so the content format (the meta in particular) needs to be updated.
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index cd4277b..e11189b 100644
--- a/README.md
+++ b/README.md
@@ -79,6 +79,23 @@ yarn dev
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. Then, you can make your changes.
+### Storybook
+
+You can search for a component or develop a new component in isolation thanks to Storybook.
+
+```bash
+yarn storybook
+```
+
+The different components are divided into 4 categories (atomic design):
+
+- Atoms
+- Molecules
+- Organisms
+- Templates
+
+But, to be honest, between _Molecules_ and _Organisms_ some components may be misclassified.
+
### i18n
When editing strings that require translation, run: