Skip to content

Commit 5e6843a

Browse files
Added CDN, CDN Badge and enhanced formatting
1 parent 507e661 commit 5e6843a

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A notification toast inspired by Google Material Design.
44

5+
[![](https://data.jsdelivr.com/v1/package/npm/node-snackbar/badge)](https://www.jsdelivr.com/package/npm/node-snackbar)
6+
57
Getting Started
68
---------------
79

@@ -15,33 +17,39 @@ or maybe you wish to use NPM...
1517
```bash
1618
npm install node-snackbar
1719
```
18-
and if that doesn't float you, you can always download the CSS and JS files...
20+
and if that doesn't float you, you can always download and implement the CSS and JS files...
1921
```html
2022
<script type="text/javascript" src="dist/snackbar.min.js"></script>
2123
<link rel="stylesheet" type="text/css" href="dist/snackbar.min.css" />
2224
```
2325

26+
or via [CDN](https://www.jsdelivr.com/package/npm/node-snackbar?path=dist)...
27+
```html
28+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/node-snackbar@latest/src/js/snackbar.min.js"></script>
29+
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/node-snackbar@latest/dist/snackbar.min.css" />
30+
```
31+
2432
Development
2533
---------------
2634

27-
In order to contribute to the development of this library you will need grunt
35+
In order to contribute to the development of this library you will need [grunt](https://gruntjs.com/)
2836

2937
```bash
3038
npm install -g grunt
3139
```
3240

33-
The files that are going to be edited are in the src folder.
34-
After making changes you will need to build the dist files by running
41+
The files that are going to be edited are in the `src/` folder.
42+
After making changes, you'll need to build the dist files by running
3543

3644
```bash
3745
grunt build
3846
```
3947

40-
The minified files will be on the dist folder. Those files are the ones used
41-
on the demo html, so simply reload the page and your changes should be visible
48+
The minified files will be in the `dist/` folder. Those files are the ones used
49+
on the demo html, so simply reload the page and your changes should be visible.
4250

4351
Happy contributing!
4452

4553
Examples
4654
--------
47-
Checkout the [Demo page](http://www.polonel.com/snackbar).
55+
Checkout the [demo page](http://www.polonel.com/snackbar).

0 commit comments

Comments
 (0)