@stakefish/ui/README.md

<div align="center"> <a href="https://www.npmjs.com/package/@stakefish/ui"><img src="https://gateway.pinata.cloud/ipfs/QmbZL1ceA8Yiz2pKALTg919jYx141DPUGegC9L4XpyayW5" width="300" /></a> </div>

<div align="center">
  <a href="https://www.npmjs.com/package/@stakefish/ui"><img src="https://gateway.pinata.cloud/ipfs/QmbZL1ceA8Yiz2pKALTg919jYx141DPUGegC9L4XpyayW5" width="300" /></a>
</div>

<h1 align="center">stakefish UI</h1>

<div align="center">

Scaffold [React](https://reactjs.org/) apps with beautiful stakefish theme.

[![](https://img.shields.io/badge/-Storybook-ff4785?logo=Storybook&logoColor=white&style=flat-square)](https://stakefish.github.io/stakefish-ui)
[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/stakefish/stakefish-ui/blob/main/LICENSE.md)
[![npm latest package](https://img.shields.io/npm/v/@stakefish/ui/latest.svg)](https://www.npmjs.com/package/@stakefish/ui)
[![npm downloads](https://img.shields.io/npm/dm/@stakefish/ui.svg)](https://www.npmjs.com/package/@stakefish/ui)
[![@stakefish](https://img.shields.io/twitter/follow/stakefish.svg?label=follow+stakefish)](https://twitter.com/stakefish)

</div>

---

## Installation and usage

To install and save in your `package.json` dependencies, run:

```bash
# yarn
$ yarn add @stakefish/ui

# npm
$ npm i @stakefish/ui
```

To use the theme, add `ThemeProvider` at the root of your React application.

```js
// YourAppRootFile.js
// ...
import { ThemeProvider } from "@stakefish/ui"

const Root = () => {
  return (
    <ThemeProvider>
      <App />
    </ThemeProvider>
  )
}
```

More detailed instructions can be found at [Getting started with `@stakefish/ui`](/docs/getting-started.md).

## Contributing

Any contribution is welcome! Please read through our [Contribution guidelines](/docs/contribution-guidelines.md) for opening issues, PRs, and development notes.

## License

This project is licensed under the Apache 2.0 License.

## Authors

- [@apple-juice](https://www.github.com/apple-juice)
- [@balajmarius](https://www.github.com/balajmarius)
- [@mateuszsokola](https://www.github.com/mateuszsokola)
- [@vince19972](https://www.github.com/vince19972)