You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/@aetherspace/README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,11 +26,11 @@ yarn dev:docs
26
26
27
27
## Up and running in minutes
28
28
29
-
`packages/@aetherspace` houses a bunch of helpers that can be imported under the `aetherspace` namespace. These aim to make your cross-platform journey a breeze. All of it has been written in Typescript and is in the process of being documented in Storybook. Feel free to edit these to your liking, but here's what it you can do with it out of the box:
29
+
`packages/@aetherspace` houses a bunch of helpers that can be imported under the `aetherspace` namespace. These aim to make your cross-platform journey a breeze. All of it has been written in Typescript and is documented in Storybook and the repo README's. Feel free to edit these to your liking if you make changes, but here's what it you can do with it out of the box:
30
30
31
31
#### Write & style your components just once
32
32
33
-
> 💚 Aetherspace primitives are ___built with [tailwind](), iOS, Android, web, node and ssr (+ media queries) in mind___.
33
+
> 💚 Aetherspace primitives are ___built with [tailwind](https://tailwindcss.com/), iOS, Android, web, node and ssr (+ media queries) in mind___.
34
34
> We mention media queries specifically because react-native-web does not support them out of the box. But we've got you covered.
> 📚 ___Documentation drives adoption___... and Storybook is a great way to do it.
136
-
> Just assign your `aetherSchema()` & `zod` powered prop definition as a __`getDocumentationProps` export__ and our scripts will __automatically turn it into Storybook controls.__
136
+
> However, it can be a pain to set up and maintain the docs for every component manually. Luckily, we've already set it up for you.
137
+
> On top of that, all you need to do is assign your `aetherSchema()` & `zod` powered prop definition as a __`getDocumentationProps` export__ and our scripts will __automatically turn it into Storybook controls.__
137
138
138
139
`../../components/MyComponent.tsx`
139
140
@@ -243,11 +244,12 @@ Performing these 6 steps has provided us with a bunch of value in little time:
<imgalt="Intro Article on DEV"longdesc="Read the Intro Artical on DEV.to"src="https://img.shields.io/badge/dev.to-0A0A0A?style=for-the-badge&logo=devdotto&logoColor=white" />
247
+
<imgalt="Intro Article on DEV"longdesc="Read the Intro Article on DEV.to"src="https://img.shields.io/badge/dev.to-0A0A0A?style=for-the-badge&logo=devdotto&logoColor=white" />
0 commit comments