@up42/up-components 2.12.1 → 3.0.0

package/README.md

@@ -6,28 +6,27 @@ https://up-components.up42.com
 
 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.
 
-
 ## Getting Started
 
 ```bash
 $ npm install @up42/up-components
 ```
 
-If you are using `yarn` you need to install the peer dependencies manually.
+If you are using `yarn` you need to install peer dependencies manually. Make sure to install the correct version for each one.
 
 ```bash
-$ yarn add @up42/up-components @mui/material @mui/icons-material @emotion/react @emotion/styled @mui/x-data-grid @mui/x-date-pickers
+$ yarn add @up42/up-components @mui/material @mui/icons-material @emotion/react @emotion/styled @mui/x-data-grid-premium @mui/x-date-pickers-pro
 ```
 
 ## Using Up Components in your application
 
-Make sure to wrap your application with the top-level `UpComponentsProvider`.
+Make sure to wrap your application with the top-level `UpComponentsProvider` and provide the [MUI X Premium License Key](https://mui.com/x/introduction/licensing/#license-key) in the `licenseKey` prop.
 
 ```tsx
 import { UpComponentsProvider, Button } from '@up42/up-components'
 
 const App = () => (
-  <UpComponentsProvider>
+  <UpComponentsProvider licenseKey={YOUR_MUI_LICENSE_KEY}>
     <Button>Hello!</Button>
   </UpComponentsProvider>
 )
@@ -42,10 +41,11 @@ Check out our [Storybook](https://up-components.up42.com) to view the available
 **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.
 
 ```js
-import { tokens } from "@up42/up-components"
+import { tokens } from '@up42/up-components'
 ```
 
 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).