Files
react/README.md
2021-08-09 16:47:11 +08:00

63 lines
1.7 KiB
Markdown

<p align="center" height="370">
<img align="center" height="370" src="https://user-images.githubusercontent.com/11304944/91128466-dfc96c00-e6da-11ea-8b03-a96e6b98667d.png">
</p>
<p align="center">
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/geist-org/react?style=for-the-badge&labelColor=000000">
<img alt="CircleCI" src="https://img.shields.io/circleci/build/github/geist-org/react?style=for-the-badge&labelColor=000000">
<img alt="npm (scoped)" src="https://img.shields.io/npm/v/@geist-ui/react?style=for-the-badge&labelColor=000000">
</p>
> Modern and minimalist React UI library, originating from Vercel's design.
<br/>
## Quick Start
1. run `yarn add @geist-ui/react` or `npm i @geist-ui/react` install it.
2. import into project:
```jsx
import { GeistProvider, CssBaseline } from '@geist-ui/react'
const Application = () => (
<GeistProvider>
<CssBaseline /> // ---> Normalize styles
<AppComponent /> // ---> Your App Component
</GeistProvider>
)
```
<br/>
## Documentation
- [Document Site](https://react.geist-ui.dev)
- [中文文档](https://react.geist-ui.dev/zh-cn)
<br/>
## Development
- [Contributing Guide](https://github.com/geist-org/react/blob/master/.github/CONTRIBUTING.md)
<br/>
## Showcases
- [Secret](https://secret.gl/)
- [Article view count](https://views-docs.unix.bio/)
- [Tree viewer for CDN](https://cdn.unix.bio/)
- [Better social image](https://img.unix.bio/)
- [SentiNEO: Near-Earth Objects Viewer](https://sentineo.app)
- [Dashboard Design](https://github.com/ofekashery/react-dashboard-design)
- [Regex-Vis: Regex visualizer & editor](https://github.com/Bowen7/regex-vis)
- [Add here](https://github.com/geist-org/react/issues/new)
<br/>
## LICENSE
[MIT](./LICENSE)