Skip to content
This repository has been archived by the owner on Jul 8, 2024. It is now read-only.
/ push.js Public archive

The world's most versatile desktop notifications framework 🌎

License

Notifications You must be signed in to change notification settings

Nickersoft/push.js

Repository files navigation



Build Status Coverage Status Known Vulnerabilities Maintainability

npm version npm Greenkeeper badge

Now a proud user of

Important Notice

Push is currently looking for co-maintainers of the repo. The guy who originally made this library, Tyler Nickerson, while still visiting this repo from time to time, is busy trying to work on his company Linguistic right now. As a result, he may not have time to answer everyone or fix bugs as quickly as they would like him too. If you find it pretty easy to find your way around this code and think you could help some people out, shoot me a message at [email protected] and let's talk.

What is Push?

Push is the fastest way to get up and running with Javascript desktop notifications. A fairly new addition to the official specification, the Notification API allows modern browsers such as Chrome, Safari, Firefox, and IE 9+ to push notifications to a user's desktop. Push acts as a cross-browser solution to this API, falling back to use older implementations if the user's browser does not support the new API.

You can quickly install Push via npm:

npm install push.js --save

Or, if you want something a little more lightweight, you can give Bower a try:

bower install push.js --save

Full Documentation

Full documentation for Push can be found at the project's new homepage https://pushjs.org. See you there!

Development

If you feel like this library is your jam and you want to contribute (or you think I'm an idiot who missed something), check out Push's neat contributing guidelines on how you can make your mark.

Credits

Push is based off the following work:

  1. HTML5-Desktop-Notifications by Tsvetan Tsvetkov
  2. notify.js by Alex Gibson