@up42/up-components 2.5.0 → 2.6.0

package/README.md

@@ -1,8 +1,11 @@
 # Up Components
 
-UP42's Shared Component Library. This is a cross-team collaborative package that enables us to reuse React components across different projects. The package uses [Storybook](https://storybook.js.org/docs/react/get-started/introduction) to organize and document UI components, and is based on [MUI](https://mui.com/getting-started/usage/) for theming and most of the APIs.
+https://up-components.up42.com
+
+**Up Components** is a cross-team collaborative component library built on UP42's design system, [Douglas](https://www.figma.com/design/cTjdGeBcufPkR8MddLQ4TU/Design-Library). It allows us to reuse React components across different applications.
+
+The package utilizes [Storybook](https://storybook.js.org/docs/react/get-started/introduction) for organizing and documenting UI components. It is based on [MUI](https://mui.com/getting-started/usage/) for theming and most of the component APIs.
 
-Up Components library provides react components based on [UP42's design system](https://www.figma.com/file/Qd9QmAdQfcsWe3xSKtJWX9FZ/Design-System)
 
 ## Getting Started
 
@@ -32,42 +35,25 @@ const App = () => (
 
 ## Available Components
 
-To see a list of available components, you can go through Storybook's Component Documentation UI, either at the following links:
-
-- Master version at https://up-components.up42.com/
-- Preview branch at https://up-components--{branch-name}.branch-preview.up42.dev/
+**Up Components** is a custom library built on top of [MUI](https://mui.com/components). It offers a set of pre-styled, ready-to-use components.
 
-You can also import components from the `@mui/material` directly from the package, instead of using `@mui`:
-
-```diff
-- import { Accordion } from '@mui/material';
-+ import { Accordion } from '@up42/up-components'
-```
+Check out our [Storybook](https://up-components.up42.com) to view the available components.
 
-**Note:** UP Components currently exports all [MUI components](https://mui.com/components/) on top of our custom ones. Which means that the existing MUI documentation can be used for any component not yet documented on our own [Storybook](https://up-components.up42.com/). In case of conflicts, our custom documentation prevails over MUI.
+**Note:** Up Components proxies all [MUI](https://mui.com/) and [MUI X](https://mui.com/x/) components. You can refer to the existing MUI documentation for any component not yet covered in our Storybook. In case of conflicts, our custom documentation takes precedence over MUI's.
 
 ### Design System Tokens
+The Douglas design system tokens are exposed as part of Up Components. You can use them to style your components.
 
-[UP42 tokens](https://github.com/up42/design-system-tokens) are also exposed as part of UpComponents.
-
-```diff
-- import tokens from '@up42/constellation-tokens/dist/json/tokens.json'
-+ import { tokens } from "@up42/up-components"
+```js
+import { tokens } from "@up42/up-components"
 ```
 
-## Working with multiple branches
-
-When working on a project using Up Components, it's important to remember that different versions might be used on different branches.
-
-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`.
-
-To avoid conflicts when working on multiple branches, remember to always run `yarn` or `npm install` after switching branches.
-
-## Developing in the Up Components package
+For more information, check our [tokens](https://up-components.up42.com?path=/docs/tokens) documentation or the [system tokens repository](https://github.com/up42/design-system-tokens).
 
-Please refer to our [Contributing Guidelines](https://github.com/up42/up-components/blob/master/CONTRIBUTING.md) for development information.
+## Up Components contributing guidelines
 
+Please refer to our [Contributing Guidelines](https://github.com/up42/up-components/blob/master/CONTRIBUTING.md) for more info.
 
 ## Troubleshooting
 
-Please refer to out [Troubleshooting](https://github.com/up42/up-components/blob/master/TROUBLESHOOTING.md) documentation.
+Please refer to our [Troubleshooting](https://github.com/up42/up-components/blob/master/TROUBLESHOOTING.md) documentation.