mirror of
https://github.com/animate-css/animate.css.git
synced 2024-11-10 21:36:31 +01:00
b0472e750e
* 🎨 Update .gitignore file * 🐛 Fix open graph errors * Fix markdown problems * Update badge URLs Co-authored-by: Waren Gonzaga <warengonzaga.dev@gmail.com>
49 lines
2.8 KiB
Markdown
49 lines
2.8 KiB
Markdown
# Animate.css
|
|
|
|
[![GitHub Version](https://img.shields.io/github/release/animate-css/animate.css.svg?style=for-the-badge)](https://github.com/animate-css/animate.css/releases) [![Github Star](https://img.shields.io/github/stars/animate-css/animate.css.svg?style=for-the-badge)](https://github.com/animate-css/animate.css/stargazers) [![Github Fork](https://img.shields.io/github/forks/animate-css/animate.css.svg?style=for-the-badge)](https://github.com/animate-css/animate.css/network/members) [![License](https://img.shields.io/github/license/animate-css/animate.css.svg?style=for-the-badge)](https://github.com/animate-css/animate.css/blob/main/LICENSE)
|
|
|
|
> If you need the old docs - v3.x.x and under - you can find it [here](https://github.com/animate-css/animate.css/tree/a8d92e585b1b302f7749809c3308d5e381f9cb17).
|
|
|
|
## _Just-add-water CSS animation_
|
|
|
|
## Installation
|
|
|
|
Install with npm:
|
|
|
|
```shell
|
|
npm install animate.css --save
|
|
```
|
|
|
|
Install with yarn:
|
|
|
|
```shell
|
|
yarn add animate.css
|
|
```
|
|
|
|
## Getting started
|
|
|
|
You can find the Animate.css documentation on the [website](https://animate.style/).
|
|
|
|
## Accessibility
|
|
|
|
Animate.css supports the [`prefers-reduced-motion` media query](https://webkit.org/blog/7551/responsive-design-for-motion/) so that users with motion sensitivity can opt out of animations. On supported platforms (currently all the majors browsers and OS), users can select "reduce motion" on their operating system preferences and it will turn off CSS transitions for them without any further work required.
|
|
|
|
## Core team
|
|
|
|
| ![Daniel Eden](https://avatars2.githubusercontent.com/u/439365?s=460&u=512b4cc5324938ae40bbb8f3b7769d335953cd3a&v=4) | ![Elton Mesquita](https://avatars2.githubusercontent.com/u/5007208?s=460&u=418401ee605824272e5dcb955fd64ea24546a857&v=4) | ![Waren Gonzaga](https://avatars1.githubusercontent.com/u/15052701?s=460&u=9e58364978379536d3f26c4ce5cae1a2a449a0e4&v=4) |
|
|
| --- | --- | --- |
|
|
| [Daniel Eden](https://github.com/daneden) | [Elton Mesquita](https://github.com/eltonmesquita) | [Waren Gonzaga](https://github.com/WarenGonzaga) |
|
|
| Animate.css Creator | Maintainer | Core Contributor |
|
|
|
|
## License
|
|
|
|
Animate.css is licensed under the MIT license. <https://opensource.org/licenses/MIT>
|
|
|
|
## Code of Conduct
|
|
|
|
This project and everyone participating in it is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [callmeelton@gmail.com](mailto:callmeelton@gmail.com).
|
|
|
|
## Contributing
|
|
|
|
Pull requests are the way to go here. We only have two rules for submitting a pull request: match the naming convention (camelCase, categorised [fades, bounces, etc]) and let us see a demo of submitted animations in a [pen](https://codepen.io). That **last one is important**.
|