@amsterdam/design-system-react 0.7.1 → 0.9.0

package/README.md

@@ -5,25 +5,27 @@
 The `@amsterdam/design-system-react` package contains React implementations of various components.
 You can use this package in React apps.
 
-The design tokens and css used in these components are published in separate npm packages, so don’t forget to install and include `@amsterdam/design-system-tokens` and `@amsterdam/design-system-css` too.
-
-<!-- TODO: make this easier? -->
+The design tokens and CSS used in these components are published in separate npm packages,
+which are automatically installed when you install the React package.
 
 ## Stability of the components
 
-The React components are released as _alpha_ version, which means the components are still work in progress and it is likely that some APIs will change between releases.
-
-Make sure you specify the exact version as dependency, so you can schedule to upgrade to the latest version when you have time to test for regression bugs.
+The React Library has not yet reached a 1.0.0 version.
+However, most of them are stable enough to be used in production.
+Components that have known issues, or for which we anticipate API changes, show a ‘beta’ badge on their page.
 
-<!-- TODO: add alpha, beta and production statuses to components. Also show in Storybook -->
+Make sure you specify the exact version as dependency.
+You can then schedule an upgrade to the latest version when you have time to test for regressions.
 
 ## Getting started
 
-Install the packages you need, for instance:
+Install the React package:
+
+`npm install @amsterdam/design-system-react`
 
-`npm install @amsterdam/design-system-react @amsterdam/design-system-tokens @amsterdam/design-system-assets @amsterdam/design-system-css`
+This will automatically add separate packages containing our design tokens, assets, icons, and stylesheets.
 
-Import the packages you need.
+Import the components and stylesheets you need, for example:
 
 ```javascript
 import { Paragraph } from "@amsterdam/design-system-react";
@@ -43,7 +45,7 @@ export default App;
 
 For applications, the large text and ample white space of the theme can be counterproductive.
 That’s why there is a compact mode.
-To use the compact mode, import the compact css **after** theme css, like so:
+To use the compact mode, import the compact CSS **after** the theme CSS, like so:
 
 ```javascript
 import "@amsterdam/design-system-tokens/dist/index.css";