Skip to content

Commit

Permalink
docs: update readme and getting started withe experimental package info
Browse files Browse the repository at this point in the history
  • Loading branch information
TomMenga committed May 29, 2024
1 parent 288d7a6 commit c2e4c28
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ Lyne Design Tokens and Lyne Components are available for developers and designer

## 🔗 Packages

| Package | Description |
| ---------------------------------- | --------------------------------------------------------------------------- |
| `@lyne-esta/elements` | Web components built on top of the Lyne Design System |
| `@lyne-esta/elements-experimental` | Web components that do not yet align with our architecture or testing goals |
| `@lyne-esta/react` | React wrappers for `@lyne-esta/elements` |
| `@lyne-esta/react-experimental` | React wrappers for `@lyne-esta/elements-experimental` |

- [NPM Packages](https://www.npmjs.com/search?q=%40sbb-esta%2Flyne-)

## 🖥 Browser and screen reader support
Expand Down
6 changes: 3 additions & 3 deletions docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Select your technology to get started.
<details>
<summary>Plain Javascript</summary>

1. Install the `@sbb-esta/lyne-elements` package:
1. Install the `@sbb-esta/lyne-elements` and `@sbb-esta/lyne-elements-experimental` package:

```sh
npm install --save @sbb-esta/lyne-elements
npm install --save @sbb-esta/lyne-elements @sbb-esta/lyne-elements-experimental
```

or, if using yarn:

```sh
yarn add @sbb-esta/lyne-elements
yarn add @sbb-esta/lyne-elements @sbb-esta/lyne-elements-experimental
```

2. Including global styles is strongly recommended to apply all SBB styles to your application.
Expand Down

0 comments on commit c2e4c28

Please sign in to comment.