Skip to content
This repository has been archived by the owner on May 13, 2024. It is now read-only.

Commit

Permalink
Deprecation notice in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
petemill committed Aug 17, 2023
1 parent e248641 commit 9e9a4f8
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,40 @@
# WARNING! This project is deprecated. Consider switching to https://github.com/brave/leo

<p align="center"><img src="./ui-logo.svg" width="130px" height="170px"/></p>

<p align="center">
<a href="https://www.npmjs.com/package/brave-ui" alt="NPM"><img src="https://img.shields.io/npm/v/brave-ui.svg" /></a>
<a href="https://travis-ci.org/brave/brave-ui" alt="Travis"><img src="https://img.shields.io/travis/brave/brave-ui.svg" /></a>
<a href="https://snyk.io/test/github/brave/brave-ui" alt="Known Vulnerabilities"><img src="https://snyk.io/test/github/brave/brave-ui/badge.svg" /></a>
<a href="#" alt="NPM"><img src="https://img.shields.io/npm/dt/brave-ui.svg" /></a>
<a href="https://lernajs.io/" alt="Lerna"><img src="https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg" /></a>
<a href="https://www.npmjs.com/package/@brave/brave-ui" alt="NPM"><img src="https://img.shields.io/npm/v/@brave/brave-ui.svg" /></a>
<a href="https://standardjs.com" alt="JavaScript Style Guide"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" /></a>
</p>

---

# :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.

```
npm run test-unit
```

## License
### License

This project is licensed under the MPL-2.0.

0 comments on commit 9e9a4f8

Please sign in to comment.