Skip to content

Commit d59ce8d

Browse files
committed
update docs
1 parent 6bb7c67 commit d59ce8d

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
11
# angular-web-notification
22

3-
[![Bower Version](https://img.shields.io/bower/v/angular-web-notification.svg?style=flat)](https://github.com/sagiegurari/angular-web-notification/releases) [![Build Status](https://img.shields.io/travis/sagiegurari/angular-web-notification.svg?style=flat)](http://travis-ci.org/sagiegurari/angular-web-notification) [![Coverage Status](https://img.shields.io/coveralls/sagiegurari/angular-web-notification.svg?style=flat)](https://coveralls.io/r/sagiegurari/angular-web-notification) [![Code Climate](https://codeclimate.com/github/sagiegurari/angular-web-notification/badges/gpa.svg)](https://codeclimate.com/github/sagiegurari/angular-web-notification) [![bitHound Score](https://www.bithound.io/sagiegurari/angular-web-notification/badges/score.svg)](https://www.bithound.io/sagiegurari/angular-web-notification) [![Inline docs](http://inch-ci.org/github/sagiegurari/angular-web-notification.svg?branch=master)](http://inch-ci.org/github/sagiegurari/angular-web-notification)<br>
3+
[![Bower Version](https://img.shields.io/bower/v/angular-web-notification.svg?style=flat)](https://github.com/sagiegurari/angular-web-notification/releases) [![Build Status](https://travis-ci.org/sagiegurari/angular-web-notification.svg)](http://travis-ci.org/sagiegurari/angular-web-notification) [![Coverage Status](https://coveralls.io/repos/sagiegurari/angular-web-notification/badge.svg)](https://coveralls.io/r/sagiegurari/angular-web-notification) [![Code Climate](https://codeclimate.com/github/sagiegurari/angular-web-notification/badges/gpa.svg)](https://codeclimate.com/github/sagiegurari/angular-web-notification) [![bitHound Score](https://www.bithound.io/sagiegurari/angular-web-notification/badges/score.svg)](https://www.bithound.io/sagiegurari/angular-web-notification) [![Inline docs](http://inch-ci.org/github/sagiegurari/angular-web-notification.svg?branch=master)](http://inch-ci.org/github/sagiegurari/angular-web-notification)<br>
44
[![License](https://img.shields.io/github/license/sagiegurari/angular-web-notification.svg)](https://github.com/sagiegurari/angular-web-notification/blob/master/LICENSE) [![Retire Status](http://retire.insecurity.today/api/image?uri=https://raw.githubusercontent.com/sagiegurari/angular-web-notification/master/bower.json)](http://retire.insecurity.today/api/image?uri=https://raw.githubusercontent.com/sagiegurari/angular-web-notification/master/bower.json)
55

66
> Web Notifications AngularJS Service
77
8+
* [Overview](#overview)
9+
* [Demo](http://plnkr.co/edit/SUTiBu?p=preview)
10+
* [Usage](#usage)
11+
* [Installation](#installation)
12+
* [Limitations](#limitations)
13+
* [API Documentation](docs/api.md)
14+
* [Release History](#history)
15+
* [License](#license)
16+
17+
<a name="overview"></a>
818
## Overview
919
The angular-web-notification is an angular service wrapper for the web notifications API.
1020

@@ -15,6 +25,7 @@ See [W3 Specification](https://dvcs.w3.org/hg/notifications/raw-file/tip/Overvie
1525
## Demo
1626
[Live Demo at Plunker](http://plnkr.co/edit/SUTiBu?p=preview)
1727

28+
<a name="usage"></a>
1829
## Usage
1930
In order to use the angular service you first must add the relevant dependencies:
2031

@@ -65,12 +76,14 @@ return {
6576
}]);
6677
```
6778

79+
<a name="installation"></a>
6880
## Installation
6981
Run bower install in your project as follows:
7082
```
7183
bower install angular-web-notification --save
7284
```
7385

86+
<a name="limitations"></a>
7487
## Limitations
7588
The web notifications API is not fully supported in all browsers.
7689

@@ -79,11 +92,12 @@ Please see http://caniuse.com/#feat=notifications for more information on the of
7992
## API Documentation
8093
See full docs at: [API Docs](docs/api.md)
8194

95+
<a name="history"></a>
8296
## Release History
8397

8498
| Date | Version | Description |
8599
| ----------- | ------- | ----------- |
86-
| 2015-09-26 | v0.0.33 | Maintenance |
100+
| 2015-10-06 | v0.0.34 | Maintenance |
87101
| 2015-09-26 | v0.0.31 | Update bower dependencies |
88102
| 2015-09-26 | v0.0.30 | Added 'onClick' option to enable adding onclick event handler for the notification |
89103
| 2015-09-02 | v0.0.29 | Maintenance |
@@ -95,5 +109,6 @@ See full docs at: [API Docs](docs/api.md)
95109
| 2014-12-09 | v0.0.3 | API now enables/disables the<br>capability to automatically request for<br>permissions needed to display the notification. |
96110
| 2014-12-08 | v0.0.2 | Initial release |
97111

112+
<a name="license"></a>
98113
## License
99114
Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license.

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "angular-web-notification",
3-
"version": "0.0.33",
3+
"version": "0.0.34",
44
"authors": [
55
"Sagie Gur-Ari <[email protected]>"
66
],

0 commit comments

Comments
 (0)