notification-handler 1.0.0.beta2 → 1.0.0.beta3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +19 -2
  3. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1eeb372b1b28269baba5376d9a4c5a206d000584cf10da928ce5ccbc8124f0f1
4
- data.tar.gz: 6e59f6f3edefd95d0c3562a71c1e039e83e9883b76f43b53196204d9082c9c55
3
+ metadata.gz: a6e4af3be4666adb9f58f8776166cf2c1c1278748d50693148864315627d371c
4
+ data.tar.gz: 7af6451a4852df716f3972385753315067883490fc557171a705c31dfa349738
5
5
  SHA512:
6
- metadata.gz: 109e473d421d2b444691365922a8a6496c4ecf876266576088d50fda23a4aae93d9364ad074a711bd711dbf0e2b0c35e858ccc712cd0d9de6dac21d4c9ca6b36
7
- data.tar.gz: 68f56618fa317923eaa72a746c29b9f5c3690df0970004e17df9d8674135145c1b63dfc482d296b35ef4a1e450ad0db6c5fcf4e8cae462ddaf8c1eb8afa507fc
6
+ metadata.gz: cd6d229a7934e0b674a8c3e8c15e5232fec64c5f381006a131c7acdf4cd9374689c52179d86d601a71e0818426765f97c355840701a5a5ae27597d5f8d3c9a13
7
+ data.tar.gz: 5136ec7b9396a03ea77712fa64665d45a4be37c598195de191e3ada882e3db9238ac35dca2fc7bed0b426fee32e08d0e2c3c85a8c3cdcb1f1bb5ce62edd1efb8
data/README.md CHANGED
@@ -2,12 +2,13 @@
2
2
 
3
3
  [![Gem Version](https://badge.fury.io/rb/notifications-rails.svg)](https://badge.fury.io/rb/notifications-rails) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
4
4
 
5
- The most powerful (cross-platform) notifications handler & pusher API for Rails.
5
+ The most powerful notification solution for Rails. NotificationsRails simplifies the handling, rendering, user-integration and cross-platform pushing of notifications through its simple API.
6
6
 
7
7
  ---
8
8
 
9
9
  ## Table of Contents
10
10
 
11
+ * [Philosophy](#philosophy)
11
12
  * [Installation](#installation)
12
13
  * [To Do](#to-do)
13
14
  * [Contributing](#contributing)
@@ -17,6 +18,22 @@ The most powerful (cross-platform) notifications handler & pusher API for Rails.
17
18
 
18
19
  ---
19
20
 
21
+ ## Philosophy
22
+
23
+ NotificationsRails has been built with modularity in mind. It currently consists of four components each of which bringing one essential functionality to the notification-integration in your Rails app.
24
+
25
+ **[NotificationHandler](notification-handler):** Create and modify your notifications through a simple API.
26
+
27
+ **[NotificationRenderer](notification-renderer):** Render your notifications on multiple platforms by specifying notification types.
28
+
29
+ **[NotificationPusher](notification-pusher):** Push your notifications to various services. Including [Email](notification-pusher-actionmailer), [ActionCable](notification-pusher-actioncable), [OneSignal](notification-pusher-onesignal).
30
+
31
+ **[NotificationSettings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
32
+
33
+ You may just add the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
34
+
35
+ ---
36
+
20
37
  ## Installation
21
38
 
22
39
  NotificationsRails works with Rails 5 onwards. You can add it to your `Gemfile` with:
@@ -53,7 +70,7 @@ To propose your ideas, initiate the discussion by adding a [new issue](https://g
53
70
 
54
71
  We hope that you will consider contributing to NotificationsRails. Please read this short overview for some information about how to get started:
55
72
 
56
- [Learn more about contributing to this repository](https://github.com/jonhue/notifications-rails/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/jonhue/notifications-rails/blob/master/CODE_OF_CONDUCT.md)
73
+ [Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
57
74
 
58
75
  ### Contributors
59
76
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: notification-handler
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.beta2
4
+ version: 1.0.0.beta3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jonas Hübotter
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-12-23 00:00:00.000000000 Z
11
+ date: 2017-12-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: railties
@@ -66,7 +66,7 @@ dependencies:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
68
  version: '0.52'
69
- description: "..."
69
+ description: Create and modify your notifications through a simple API.
70
70
  email: jonas.huebotter@gmail.com
71
71
  executables: []
72
72
  extensions: []
@@ -97,5 +97,5 @@ rubyforge_project:
97
97
  rubygems_version: 2.7.3
98
98
  signing_key:
99
99
  specification_version: 4
100
- summary: "..."
100
+ summary: Create and modify your notifications through a simple API
101
101
  test_files: []