Skip to content

Commit 31b56e6

Browse files
committed
First draft
First draft of read me
1 parent 9a30fd4 commit 31b56e6

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
# Hover Box (A JavaScript package)
22

3-
Some text
3+
A simple package to reveal some extra information on hover
4+
5+
> ⚠ There is still some CSS to add to the package. For now, you can implement the styling how you see fit
6+
7+
## Usage
8+
9+
Add the below to your code to your project and you're away
10+
11+
```TS
12+
const hB = new HoverBox(".HoverBox");
13+
14+
// Inside some other functions somewhere
15+
hB.startListening();
16+
hB.stopListening();
17+
```
18+
19+
## Changes
20+
21+
You can see all the changes in our [change log](./CHANGELOG.md)
22+
23+
## License
24+
25+
This extension is licensed under the [MIT License](./LICENSE)

0 commit comments

Comments
 (0)