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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amcdnl authored Feb 14, 2024
1 parent 2823c7e commit c91c966
Showing 1 changed file with 2 additions and 49 deletions.
51 changes: 2 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,55 +28,8 @@

---

## 🚀 Quick Links
- View the [Docs and Demos](https://reaviz.github.io/reaselct/)
- Play with examples in [CodeSandbox](https://codesandbox.io/s/reaselct-6gv07)
- Learn about updates from the [changelog](CHANGELOG.md)

## 🪄 Features
- Single Select
- Multi Select
- Filtering with Fuzzy Search
- Async Support
- Groups Support
- Light and Dark Theme

## 📦 Usage
Install the package via NPM:

```
npm i reaselct --save
```

then use it like:

```tsx
import React, { FC, useState } from 'react';
import { Select, SelectOption } from 'reaselct';

const MyComponent: FC = () => {
const [value, setValue] = useState<string | null>(null);

return (
<Select
value={value}
onChange={setValue}
>
<SelectOption value="facebook">facebook</SelectOption>
<SelectOption value="twitter">twitter</SelectOption>
<SelectOption value="twitch">twitch</SelectOption>
</Select>
);
};
```

## 🔭 Development
If you want to run `reaselct` locally, its super easy!

- Clone the repo
- `yarn install`
- `yarn start`
- Browser opens to Storybook page
## Deprecated
This package is deprecated and part of [https://reablocks.dev](https://reablocks.dev) now.

## ❤️ Contributors
Thanks to all our contributors!
Expand Down

0 comments on commit c91c966

Please sign in to comment.