Skip to content

Commit da7ddc0

Browse files
committed
Cleanup readme
1 parent 29baa05 commit da7ddc0

File tree

7 files changed

+7
-75
lines changed

7 files changed

+7
-75
lines changed

.size-limit.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,24 @@
33
"name": "useAnimation",
44
"path": "lib/index.mjs",
55
"import": "{ useAnimation }",
6-
"limit": "1.5 kB"
6+
"limit": "1.0 kB"
77
},
88
{
99
"name": "useAnimationFunction",
1010
"path": "lib/index.mjs",
1111
"import": "{ useAnimationFunction }",
12-
"limit": "1.5 kB"
12+
"limit": "1.0 kB"
1313
},
1414
{
1515
"name": "useTransitionAnimation",
1616
"path": "lib/index.mjs",
1717
"import": "{ useTransitionAnimation }",
18-
"limit": "1.5 kB"
18+
"limit": "1.2 kB"
1919
},
2020
{
2121
"name": "TransitionGroup",
2222
"path": "lib/index.mjs",
2323
"import": "{ TransitionGroup }",
24-
"limit": "1.5 kB"
24+
"limit": "0.5 kB"
2525
}
2626
]

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,16 @@
22

33
![npm](https://img.shields.io/npm/v/react-animatable) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-animatable) [![check](https://github.com/inokawa/react-animatable/actions/workflows/check.yml/badge.svg)](https://github.com/inokawa/react-animatable/actions/workflows/check.yml) [![demo](https://github.com/inokawa/react-animatable/actions/workflows/demo.yml/badge.svg)](https://github.com/inokawa/react-animatable/actions/workflows/demo.yml)
44

5-
A powerful composable animation library for [React](https://github.com/facebook/react), built on [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) and React hook.
5+
A tiny(~1kB) animation hooks for [React](https://github.com/facebook/react), built on [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).
66

77
<img src="./images/demo-chart.gif" width="350px" /><img src="./images/demo-mouse.gif" width="350px" />
88

9-
<img src="./images/demo-scroll.gif" width="350px" /><img src="./images/demo-alphabet.gif" width="350px" />
10-
119
## Features
1210

1311
- Performant animation driven by native [Web Animations API (WAAPI)](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).
14-
- Easy integration with a few lines of code.
15-
- Supports any UI component libraries, [Material UI](https://github.com/mui/material-ui), [Chakra UI](https://github.com/chakra-ui/chakra-ui), [Ant Design](https://github.com/ant-design/ant-design), [Fluent UI](https://github.com/microsoft/fluentui), [Mantine](https://github.com/mantinedev/mantine) and the others.
16-
- Supports any CSS-in-JS libraries, [styled-components](https://github.com/styled-components/styled-components), [emotion](https://github.com/emotion-js/emotion), [stitches](https://github.com/stitchesjs/stitches), [vanilla-extract](https://github.com/vanilla-extract-css/vanilla-extract), [linaria](https://github.com/callstack/linaria), [compiled](https://github.com/atlassian-labs/compiled) and the others.
17-
- Supports [Next.js](https://github.com/vercel/next.js) and server-side rendering (SSR).
12+
- Easy integration with a few lines of code. Works with any UI component libraries or CSS-in-JS libraries.
1813
- HTML, SVG, Canvas and anything can be animated.
19-
- [Tiny bundle size (currently about 2kB gzipped)](https://bundlephobia.com/package/react-animatable) and has zero dependencies. Of course treeshakeable
14+
- Tiny. Each hooks are ~1kB gzipped and [the total is ~2kB gzipped](https://bundlephobia.com/package/react-animatable).
2015
- Fully typed with [TypeScript](https://www.typescriptlang.org/), which is stricter than TypeScript's [lib.dom.d.ts](https://github.com/microsoft/TypeScript/blob/main/lib/lib.dom.d.ts).
2116
- Composable and declarative APIs based on React hook.
2217

images/demo-alphabet.gif

-1.11 MB
Binary file not shown.

images/demo-scroll.gif

-518 KB
Binary file not shown.

package-lock.json

Lines changed: 0 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@
4949
"@rollup/plugin-terser": "^0.4.1",
5050
"@rollup/plugin-typescript": "11.1.3",
5151
"@size-limit/preset-small-lib": "^8.2.6",
52-
"@stitches/react": "1.2.8",
5352
"@storybook/addon-storysource": "7.4.0",
5453
"@storybook/react": "7.4.0",
5554
"@storybook/react-webpack5": "^7.4.0",

stories/with-libraries/css-in-js/stitches.stories.tsx

Lines changed: 0 additions & 46 deletions
This file was deleted.

0 commit comments

Comments
 (0)