notifications-rails 1.0.0.beta2 → 1.0.0.beta3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +6 -1
  3. data/README.md +19 -2
  4. metadata +19 -12
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a39666997b0578b56151e7ec754cfc5781b38f5ccc39fb2c4c6b3d1289b26bb2
4
- data.tar.gz: c8f5425ce6181c9861a92876b9d51129fe9b37c657d3444f7537b2ec4475fa2c
3
+ metadata.gz: eae5e67e51c59322e6c460e54c96876e071936ff562785ceb34970b161676815
4
+ data.tar.gz: c0c4686531abff2acf1784aabfb61187385333189b916b8375ddbcb30857d283
5
5
  SHA512:
6
- metadata.gz: a5909114eddad4ff9782bfa3d91c3c26f1708edcbd34025cafcfdbbab29182ebbf3ce158e8b21a2e6028b218d564a4bdc3997bd3780ef6b70759f9970ca7cce1
7
- data.tar.gz: 2496f74b22d0ab30e6e049a92c179b9df63bc6c4ae500f9e20c6769dc203159830d82157a030ac9f4d9ac341f5f58f2b39a320f50301cbb00677ee01891c4905
6
+ metadata.gz: 34bfc69887851c948ce4f44a3368a53e227f72b139ce2af89f407132062ef304fd652e7ba46ac7e83449c48b789d59d409bfd2eaf7618e3dc7d55e0f38fabb17
7
+ data.tar.gz: e82525295d95d7a4c2613e1d8c3a9af7829477447697d4652714f34267253a3ff96adee6125f04f48276320d8f028529eeaa35aae0d62af515ad769009378b91
data/INSTALL.md CHANGED
@@ -1,7 +1,12 @@
1
1
  **Thank you for installing NotificationsRails!**
2
2
 
3
3
 
4
- // Add instructions
4
+ To wrap up installing NotificationsRails, run the generators to install each component.
5
+
6
+ rails g notification_handler:install
7
+ rails g notification_renderer:install
8
+ rails g notification_pusher:install
9
+ rails g notification_settings:install
5
10
 
6
11
 
7
12
  Learn more at https://github.com/jonhue/notifications-rails
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: notifications-rails
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: notification-handler
@@ -16,56 +16,56 @@ dependencies:
16
16
  requirements:
17
17
  - - '='
18
18
  - !ruby/object:Gem::Version
19
- version: 1.0.0.beta2
19
+ version: 1.0.0.beta3
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - '='
25
25
  - !ruby/object:Gem::Version
26
- version: 1.0.0.beta2
26
+ version: 1.0.0.beta3
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: notification-renderer
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - '='
32
32
  - !ruby/object:Gem::Version
33
- version: 1.0.0.beta2
33
+ version: 1.0.0.beta3
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - '='
39
39
  - !ruby/object:Gem::Version
40
- version: 1.0.0.beta2
40
+ version: 1.0.0.beta3
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: notification-pusher
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - '='
46
46
  - !ruby/object:Gem::Version
47
- version: 1.0.0.beta2
47
+ version: 1.0.0.beta3
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - '='
53
53
  - !ruby/object:Gem::Version
54
- version: 1.0.0.beta2
54
+ version: 1.0.0.beta3
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: notification-settings
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - '='
60
60
  - !ruby/object:Gem::Version
61
- version: 1.0.0.beta2
61
+ version: 1.0.0.beta3
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - '='
67
67
  - !ruby/object:Gem::Version
68
- version: 1.0.0.beta2
68
+ version: 1.0.0.beta3
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: rspec
71
71
  requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,9 @@ dependencies:
94
94
  - - "~>"
95
95
  - !ruby/object:Gem::Version
96
96
  version: '0.52'
97
- description: "..."
97
+ description: The most powerful notification solution for Rails. NotificationsRails
98
+ simplifies the handling, rendering, user-integration and cross-platform pushing
99
+ of notifications through its simple API.
98
100
  email: jonas.huebotter@gmail.com
99
101
  executables: []
100
102
  extensions: []
@@ -111,7 +113,12 @@ post_install_message: |
111
113
  **Thank you for installing NotificationsRails!**
112
114
 
113
115
 
114
- // Add instructions
116
+ To wrap up installing NotificationsRails, run the generators to install each component.
117
+
118
+ rails g notification_handler:install
119
+ rails g notification_renderer:install
120
+ rails g notification_pusher:install
121
+ rails g notification_settings:install
115
122
 
116
123
 
117
124
  Learn more at https://github.com/jonhue/notifications-rails