font-awesome-animation/README.md
2021-01-21 20:48:51 +01:00

43 lines
925 B
Markdown

# font-awesome-animation ![build](https://github.com/l-lin/font-awesome-animation/workflows/build/badge.svg) [![npm version](https://badge.fury.io/js/font-awesome-animation.svg)](https://badge.fury.io/js/font-awesome-animation)
> Simple animations using some CSS3 I found on the web.
> Best used on glyphicons like [FontAwesome](http://fortawesome.github.io/Font-Awesome/).
## Getting started
Add
```bash
npm install font-awesome-animation
```
Include CSS file in your index.html file:
```html
<link rel="stylesheet" href="font-awesome-animation.min.css">
```
## Usage
See [live demo](https://l-lin.github.com/font-awesome-animation).
## Development
This project is using:
- the CSS preprocessor [Myth](http://www.myth.io/) to generate the prefixes for common browsers
```bash
# install dependencies
npm install
# generate prefixes and minified CSS files
npm run build
```
## License
[MIT License](LICENSE)