@up42/up-components 0.6.1 → 0.6.2
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 +18 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ If you are using `yarn` you need to install the peer dependencies manually.
|
|
|
16
16
|
$ yarn add @up42/up-components @mui/material @mui/icons-material @emotion/react @emotion/styled @mui/x-data-grid
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
## Using
|
|
19
|
+
## Using Up Components in your application
|
|
20
20
|
|
|
21
21
|
Make sure to wrap your application with the top-level `UpComponentsProvider`.
|
|
22
22
|
|
|
@@ -55,6 +55,22 @@ You can also import components from the `@mui/material` directly from the packag
|
|
|
55
55
|
+ import { tokens } from "@up42/up-components"
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
##
|
|
58
|
+
## Working with multiple branches
|
|
59
|
+
|
|
60
|
+
When working on a project using Up Components, it's important to remember that different versions might be used on different branches.
|
|
61
|
+
|
|
62
|
+
For example, your project's master branch might be using Up Components version `0.4.9`, while your feature branch might be using version `0.5.0`.
|
|
63
|
+
|
|
64
|
+
To avoid conflicts when working on multiple branches, remember to always run `yarn` or `npm install` after switching branches.
|
|
65
|
+
|
|
66
|
+
## Developing in the Up Components package
|
|
59
67
|
|
|
60
68
|
Please refer to our [Contributing Guidelines](https://github.com/up42/up-components/blob/master/CONTRIBUTING.md) for development information.
|
|
69
|
+
|
|
70
|
+
## Migrating from Material UI 4
|
|
71
|
+
|
|
72
|
+
Please refer to our [Migration](https://github.com/up42/up-components/blob/master/MIGRATION.md) guidelines.
|
|
73
|
+
|
|
74
|
+
## Troubleshooting
|
|
75
|
+
|
|
76
|
+
Please refer to out [Troubleshooting](https://github.com/up42/up-components/blob/master/TROUBLESHOOTING.md) documentation.
|