Skip to content

Commit d397b9f

Browse files
committed
updated read me
1 parent feaaa86 commit d397b9f

12 files changed

+69
-9
lines changed

β€Ž.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# /sass/button/
22
# /sass/util/
3-
# /pvt
3+
# /pvt
4+
/node_modules

β€ŽREADME.md

+29-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,33 @@
1-
# hoveron by (https://knowankit.com)
2-
A css file to create basic button animation transition.
1+
# Hover-on.css
2+
Pure css button animation
33

4-
## Demo
4+
`hover-on.css` has creative animations and transitions for your projects. It's great to make your buttons look awesome.
55

6-
[Click here](https://hover-on.netlify.com/)
6+
## Installation
7+
Install via npm:
78

8-
### Upcoming
9+
`$ npm install hover-on`
910

10-
* CDN Link for the buttons
11-
* Component based button to make it easier to implement
12-
* New designs
11+
## Usage
12+
To use hover-on.css in your website, just add the stylesheet into your document's `<head>`, add the appropriate class to the button. That's it! You've got a animated button. Cool!
13+
14+
```html
15+
<head>
16+
<link rel="stylesheet" href="hover-on.min.css">
17+
</head>
18+
```
19+
or use a CDN hosted version by [CDNJS](htttps://knowankit.com)
20+
21+
```html
22+
<head>
23+
<link rel="stylesheet" href="https://hover-on.min.css">
24+
</head>
25+
```
26+
27+
## Animations
28+
29+
| Class Name | | |
30+
| ------------- |:-------------:| -----:|
31+
| | | |
32+
| | | |
33+
| | | |

β€Žpackage-lock.json

+13
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žpackage.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"name": "hover-on",
3+
"version": "1.0.0",
4+
"description": "A file containing basics of button animation",
5+
"main": "components.css",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"repository": {
10+
"type": "git",
11+
"url": "git+https://github.com/knowankit/hoveron.git"
12+
},
13+
"keywords": [
14+
"buttons",
15+
"animations",
16+
"hover-animation",
17+
"button-animation"
18+
],
19+
"author": "Ankit",
20+
"license": "MIT",
21+
"bugs": {
22+
"url": "https://github.com/knowankit/hoveron/issues"
23+
},
24+
"homepage": "https://knowankit.com"
25+
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
Β (0)