Skip to content

Commit c4d0300

Browse files
committed
🤘 adding the readme
1 parent f576cee commit c4d0300

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Loud Links
2+
The library creates HTML5 audio element and uses it to play mp3/ogg audio files which is currently [supported](http://caniuse.com/#feat=audio) in all browsers.
3+
4+
## Usage
5+
6+
------------------------
7+
8+
It’s super simple, attach the library to your project and follow these 3 steps:
9+
10+
### Step 1
11+
12+
At the root of your website directory create a folder named **“sounds”** with 2 more folders inside it with the names **“mp3”** & **“ogg”**.
13+
14+
![sound folders](http://loudlinks.rocks/images/sound-folders.png)
15+
16+
------------------------
17+
18+
### Step 2
19+
20+
Add the class **“loud-link-hover”** to any link/element that you want to give a sound on hover.
21+
22+
```html
23+
<div class=“loud-link-hover”></div>
24+
```
25+
26+
Or add the class **“loud-link-click”** to any link/element that you want to give a sound on click.
27+
28+
```html
29+
<div class=“loud-link-click”></div>
30+
```
31+
* * *
32+
33+
### Step 3
34+
35+
Add the attribute **“src-data”** to the element & write in it the name of your sound without the extension.
36+
37+
```html
38+
<div class=“loud-link-click”></div>
39+
```
40+
41+
------------------------
42+
43+
44+
## Done & Done
45+
# [Demo](http://loudlinks.rocks)
46+
# [Download](https://mahdif.github.io/loud-links/loudlinks-1.0.min.js)

0 commit comments

Comments
 (0)