From 9e9a4f836a1d5eee9040f0ec192c74fec845befc Mon Sep 17 00:00:00 2001 From: Pete Miller Date: Fri, 4 Aug 2023 21:05:47 -0700 Subject: [PATCH] Deprecation notice in readme --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 08953f52..fcc437ef 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,33 @@ +# WARNING! This project is deprecated. Consider switching to https://github.com/brave/leo +

- - - - - +

--- -# :wave: Welcome to Brave UI +## :wave: Welcome to Brave UI Here you will find a list of reusable React components used in most of Brave products. Brave UI's [component library](https://brave.github.io/brave-ui) can be found on Storybook. :exclamation:**Important:** We are still hacking a lot on this project, and therefore don't recommend that anyone use it yet. It's free to try and use at your own risk but bear in mind that components and APIs are very likely to change without notice. -## Installation +### Installation ``` $ npm install ``` -## Using Brave UI +### Using Brave UI ``` npm run storybook-start ``` -## Tests +### Tests We use Jest for testing. Playground is available under the `stories/` folder. @@ -37,6 +35,6 @@ We use Jest for testing. Playground is available under the `stories/` folder. npm run test-unit ``` -## License +### License This project is licensed under the MPL-2.0.