Skip to content

Commit 649133c

Browse files
committed
update documentation
1 parent 0ac4f91 commit 649133c

File tree

3 files changed

+45
-33
lines changed

3 files changed

+45
-33
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## 0.1.0
4+
5+
* Add removeNotifications method #13

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Need to use at least Bootstrap 3 or jQuery UI to make pretty notifications.
3232

3333
Include at least Bootstrap 3 or jQuery UI CSS.
3434

35-
Include PNotify related assets. You need to include at least pnotify.core.css and pnotify.core.js.
35+
Include PNotify related assets. You need to include at least pnotify.css and pnotify.js.
3636
Don't forget pnotify.confirm.js if you need confirmation dialogs.
3737

3838
Then add angular-pnotify.js.
@@ -41,14 +41,14 @@ Here is an example using Bootstrap 3.
4141

4242
```html
4343
<link rel="stylesheet" href="bower_components/bootstrap/dist/css/bootstrap.min.css">
44-
<link rel="stylesheet" href="bower_components/pnotify/pnotify.core.css">
45-
<link rel="stylesheet" href="bower_components/pnotify/pnotify.buttons.css">
44+
<link rel="stylesheet" href="bower_components/pnotify/dist/pnotify.css">
45+
<link rel="stylesheet" href="bower_components/pnotify/dist/pnotify.buttons.css">
4646

4747
<script src="bower_components/jquery/dist/jquery.min.js"></script>
4848
<script src="bower_components/angular/angular.js"></script>
49-
<script src="bower_components/pnotify/dist/pnotify.core.js"></script>
50-
<script src="bower_components/pnotify/pnotify.confirm.js"></script>
51-
<script src="bower_components/pnotify/pnotify.buttons.js"></script>
49+
<script src="bower_components/pnotify/dist/pnotify.js"></script>
50+
<script src="bower_components/pnotify/dist/pnotify.confirm.js"></script>
51+
<script src="bower_components/pnotify/dist/pnotify.buttons.js"></script>
5252
<script src="bower_components/angular-pnotify/src/angular-pnotify.js"></script>
5353
```
5454

@@ -109,6 +109,12 @@ clearing all defaults.
109109

110110
`notificationService.notifyWithDefaults(options, [stack name]);`
111111

112+
#### removeNotifications
113+
114+
Will clear all currently showing notifications.
115+
116+
`notificationService.removeNotifications();`
117+
112118
### Provider
113119

114120
Sometimes you want to set defaults for the whole application. You can do so in your module's config.

bower.json

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
{
2-
"name": "angular-pnotify",
3-
"version": "0.1.0",
4-
"homepage": "https://github.com/jacqueslareau/angular-pnotify",
5-
"authors": [
6-
"Jacques Lareau <[email protected]>"
7-
],
8-
"description": "AngularJS wrapper for PNotify",
9-
"main": "./src/angular-pnotify.js",
10-
"keywords": [
11-
"angular",
12-
"notification",
13-
"pines",
14-
"pnotify"
15-
],
16-
"license": "MIT",
17-
"ignore": [
18-
"**/.*",
19-
"node_modules",
20-
"bower_components",
21-
"test",
22-
"tests"
23-
],
24-
"dependencies": {
25-
"angular": "~1.5.5",
26-
"pnotify": "~3.0.0",
27-
"jquery": ">=1.9"
28-
}
2+
"name": "angular-pnotify",
3+
"version": "0.1.0",
4+
"homepage": "https://github.com/jacqueslareau/angular-pnotify",
5+
"authors": [
6+
"Jacques Lareau <[email protected]>"
7+
],
8+
"description": "AngularJS wrapper for PNotify",
9+
"main": "./src/angular-pnotify.js",
10+
"keywords": [
11+
"angular",
12+
"notification",
13+
"pines",
14+
"pnotify"
15+
],
16+
"license": "MIT",
17+
"ignore": [
18+
"**/.*",
19+
"node_modules",
20+
"bower_components",
21+
"test",
22+
"tests"
23+
],
24+
"dependencies": {
25+
"angular": "~1.5.5",
26+
"pnotify": "~3.0.0",
27+
"jquery": ">=1.9",
28+
"bootstrap": "^3.3.6"
29+
}
2930
}

0 commit comments

Comments
 (0)