From 11a41156d5b3eedc48e30e7f54bea4dfb439d39e Mon Sep 17 00:00:00 2001 From: Kiarokh Moattar Date: Mon, 16 Sep 2024 15:24:38 +0200 Subject: [PATCH] docs(README): add information about the `@beta` components --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 443117ef7f..3918247f01 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ For a full list of components, along with live examples, please visit the [docum [![Version](https://img.shields.io/npm/v/@limetech/lime-elements.svg)](https://www.npmjs.com/package/@limetech/lime-elements) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) +--- + ## Getting Started - To install, run `npm install @limetech/lime-elements`. @@ -74,10 +76,26 @@ Providing your own icons is crucial as many of our components use an `Icon` inte ``` +--- + +## Using @beta components + +Components marked as `@beta` are not yet stable. Here's what you need to know: + +1. **Breaking changes:** We may change `@beta` components in ways that break your code. We won't increase the major version number when we do this. +1. **Unstable:** `@beta` components may have more bugs than other components. Use them at your own risk. +1. **Feedback wanted:** We offer `@beta` components to get your input. Your feedback helps us improve them. + +Remember: All components can change, but `@beta` components change more often and without warning. + +--- + ## Getting help - If you have a general question, or are in need of support, please open a [Question issue](https://github.com/Lundalogik/lime-elements/issues/new?template=03_question.md) on GitHub. +--- + ## Contributing - To build and run the documentation locally on your machine, run `npm start`.