mainstack-design-system 0.3.7 → 0.3.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -10,6 +10,21 @@ To view the design system documentation, visit this [link](https://mainstack-des
|
|
|
10
10
|
|
|
11
11
|
# Usage
|
|
12
12
|
|
|
13
|
+
Install the design system
|
|
14
|
+
|
|
15
|
+
`yarn add mainstack-design-system`
|
|
16
|
+
|
|
17
|
+
Add the Design system provider to your root file
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
import { MainstackProvider } from "mainstack-design-system";
|
|
21
|
+
|
|
22
|
+
<MainstackProvider>
|
|
23
|
+
<App/>
|
|
24
|
+
</MainstackProvider>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
|
13
28
|
## Components
|
|
14
29
|
|
|
15
30
|
Components can be used by importing from the `'mainstack-design-system` directory. For example:
|
|
@@ -27,7 +42,7 @@ Icons are imported from the `'mainstack-design-system` directory. For example:
|
|
|
27
42
|
Colors are imported from the `mainstack-design-system` directory. For example:
|
|
28
43
|
|
|
29
44
|
```
|
|
30
|
-
import {Colors} from "mainstack-design-system
|
|
45
|
+
import {Colors} from "mainstack-design-system";
|
|
31
46
|
|
|
32
47
|
<Text color={Colors.black300}>Hello World</Text>
|
|
33
48
|
```
|