Fishies 0.8.1
This commit is contained in:
parent
5821ce9f4d
commit
b74d63ddf6
1 changed files with 18 additions and 2 deletions
20
README.md
20
README.md
|
|
@ -1,3 +1,17 @@
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://fishies.lol/ui"><img src="https://fishies.lol/ui/banner.webp" alt="Fishies UI: plump buttons, water glass with a gold rim and a painted icon set" width="100%"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://www.npmjs.com/package/@fishies/ui"><img src="https://img.shields.io/npm/v/@fishies/ui?style=flat-square&color=f4c656&labelColor=0b2233&label=%40fishies%2Fui" alt="npm version"></a>
|
||||||
|
<a href="https://www.npmjs.com/package/@fishies/ui"><img src="https://img.shields.io/npm/dm/@fishies/ui?style=flat-square&color=5cd8c6&labelColor=0b2233&label=downloads" alt="npm downloads"></a>
|
||||||
|
<a href="https://bundlephobia.com/package/@fishies/ui"><img src="https://img.shields.io/bundlephobia/minzip/@fishies/ui?style=flat-square&color=83cfbd&labelColor=0b2233&label=min%2Bgzip" alt="bundle size"></a>
|
||||||
|
<img src="https://img.shields.io/badge/react-18%2B-83cfbd?style=flat-square&labelColor=0b2233" alt="React 18 or newer">
|
||||||
|
<img src="https://img.shields.io/badge/types-included-83cfbd?style=flat-square&labelColor=0b2233" alt="TypeScript types included">
|
||||||
|
<a href="LICENSE"><img src="https://img.shields.io/badge/code-MIT-f4c656?style=flat-square&labelColor=0b2233" alt="code MIT"></a>
|
||||||
|
<a href="https://fishies.lol/ui"><img src="https://img.shields.io/badge/showcase-fishies.lol%2Fui-f4c656?style=flat-square&labelColor=0b2233" alt="live showcase"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
# @fishies/ui
|
# @fishies/ui
|
||||||
|
|
||||||
The kit the social aquarium game [Fishies](https://fishies.lol) is drawn with: reef-toy React
|
The kit the social aquarium game [Fishies](https://fishies.lol) is drawn with: reef-toy React
|
||||||
|
|
@ -5,9 +19,11 @@ components, design tokens as CSS variables and as data, and the painted system i
|
||||||
piece live, with the Fishies Handbook, at **https://fishies.lol/ui**.
|
piece live, with the Fishies Handbook, at **https://fishies.lol/ui**.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm i @fishies/ui
|
bun add @fishies/ui
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<sub>npm i @fishies/ui · pnpm add @fishies/ui · yarn add @fishies/ui</sub>
|
||||||
|
|
||||||
## Use it
|
## Use it
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
|
|
@ -41,4 +57,4 @@ stylesheet that does, and every component animates with them; leave them out and
|
||||||
| `icons/` | the painted icon set, one PNG per name, each twice its largest display size |
|
| `icons/` | the painted icon set, one PNG per name, each twice its largest display size |
|
||||||
| `handbook/` | the Fishies Handbook as Markdown |
|
| `handbook/` | the Fishies Handbook as Markdown |
|
||||||
|
|
||||||
Version 0.8.1 matches the Fishies release it was taken from.
|
Version 0.8.1: the minor version follows the Fishies release it was taken from; a patch is a fix to the kit itself.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue