NotificationPusher for ActionCable
A pusher to serve your notifications through WebSockets wit ActionCable.
Table of Contents
Installation
NotificationPusher for ActionCable works with Rails 5 onwards. You can add it to your Gemfile with:
gem 'notification-pusher-actioncable'
And then execute:
$ bundle
Or install it yourself as:
$ gem install notification-pusher-actioncable
If you always want to be up to date fetch the latest from GitHub in your Gemfile:
gem 'notification-pusher-actioncable', github: 'jonhue/notifications-rails'
Usage
Basic usage
Options
...
To Do
Here is the full list of current projects.
To propose your ideas, initiate the discussion by adding a new issue.
Contributing
We hope that you will consider contributing to NotificationPusher for ActionCable. Please read this short overview for some information about how to get started:
Learn more about contributing to this repository, Code of Conduct
Contributors
Give the people some :heart: who are working on this project. See them all at:
https://github.com/jonhue/notifications-rails/graphs/contributors
Semantic Versioning
NotificationPusher for ActionCable follows Semantic Versioning 2.0 as defined at http://semver.org.
License
MIT License
Copyright (c) 2017 Jonas Hübotter
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.