docs: add initial README

mittwald · Jan 25, 2024 · 6b7aa25 · 6b7aa25
1 parent 7029f93
commit 6b7aa25
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 0 deletions.
diff --git a/packages/components/README.md b/packages/components/README.md
@@ -0,0 +1,32 @@
+# mittwald Flow Components
+
+> ⚠️ **EARLY DEVELOPMENT &mdash; STABILITY NOTICE**
+>
+> This project is in **early development** stage, and we do not offer any
+> stability guarantees of any kind. We welcome you to give this project a try
+> and we're looking forward for any feedback on this project in this stage of
+> development. However, please do not rely on any inputs or outputs of this
+> project to remain stable.
+
+## Installing
+
+With npm:
+
+```shell
+$ npm install @mittwald/flow-next-components
+```
+
+With Yarn:
+
+```shell
+$ yarn add @mittwald/flow-next-components
+```
+
+## Import styles
+
+You have to import the bundled stylesheet in order to get the correct component
+styles. The stylesheet can be imported from:
+
+```
+@mittwald/flow-next-components/styles
+```
diff --git a/packages/design-tokens/README.md b/packages/design-tokens/README.md
@@ -0,0 +1,23 @@
+# mittwald Flow Components
+
+> ⚠️ **EARLY DEVELOPMENT &mdash; STABILITY NOTICE**
+>
+> This project is in **early development** stage, and we do not offer any
+> stability guarantees of any kind. We welcome you to give this project a try
+> and we're looking forward for any feedback on this project in this stage of
+> development. However, please do not rely on any inputs or outputs of this
+> project to remain stable.
+
+## Installing
+
+With npm:
+
+```shell
+$ npm install @mittwald/flow-next-design-tokens
+```
+
+With Yarn:
+
+```shell
+$ yarn add @mittwald/flow-next-design-tokens
+```
diff --git a/packages/stylesheet/README.md b/packages/stylesheet/README.md
@@ -0,0 +1,23 @@
+# mittwald Flow Components
+
+> ⚠️ **EARLY DEVELOPMENT &mdash; STABILITY NOTICE**
+>
+> This project is in **early development** stage, and we do not offer any
+> stability guarantees of any kind. We welcome you to give this project a try
+> and we're looking forward for any feedback on this project in this stage of
+> development. However, please do not rely on any inputs or outputs of this
+> project to remain stable.
+
+## Installing
+
+With npm:
+
+```shell
+$ npm install @mittwald/flow-next-stylesheet
+```
+
+With Yarn:
+
+```shell
+$ yarn add @mittwald/flow-next-stylesheet
+```