notification-renderer 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e35c558ef120efa94fe1091d7901881131024e2e642924fcd22ce1dfcdd359d9
-  data.tar.gz: 86a460ec4f77c802da8476f59e1ccf4173c19ecf47b98e14bc5557aba838f003
+  metadata.gz: 047a1b2281e096172e2266edc3e31a20103f3683e73579ce13e4dd5a5595f17e
+  data.tar.gz: 49de13ce8ff617c2e2334751fd878bd9b8f32586955756dcfd807fbd2404f6aa
 SHA512:
-  metadata.gz: 6b9147e40f21e21ca8d7d32ee937b2246960886cfc5c504ef99a45d5e9d7414ab52ebb1f884cfcafb826ebe957721fd302f9c047d3685616c4fa08b45792349a
-  data.tar.gz: e8073a9ab499471123823a96a9e610b59df6c4ccc0699dbc706111bf955b1e1a253f829fc14fe722afd8dcb09246b8d4d3e3613b1e50d620792b663958060391
+  metadata.gz: 3e2fb4e46a692d956880c8ffdb87dc7584eed8f9066c9c78f852b3a1552d90585e96c1d4b9ee77171197643b2c4a3af9125381e9616b3aae663473af7e579446
+  data.tar.gz: a0e5a992461c25e3d474c1973f656a0e9690626f88f49fddd4c4764c3473de5e5774fcf1f78a24d382ec71bfb59203efd7dbb31a8f1dacc52b5715aaf5cb89a6

data/README.md

@@ -2,12 +2,13 @@
 
 [![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" />
 
-The most powerful (cross-platform) notifications handler & pusher API for Rails.
+The most powerful notification solution for Rails. NotificationsRails simplifies the handling, rendering, user-integration and cross-platform pushing of notifications through its simple API.
 
 ---
 
 ## Table of Contents
 
+* [Philosophy](#philosophy)
 * [Installation](#installation)
 * [To Do](#to-do)
 * [Contributing](#contributing)
@@ -17,6 +18,22 @@ The most powerful (cross-platform) notifications handler & pusher API for Rails.
 
 ---
 
+## Philosophy
+
+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.
+
+**[NotificationHandler](notification-handler):** Create and modify your notifications through a simple API.
+
+**[NotificationRenderer](notification-renderer):** Render your notifications on multiple platforms by specifying notification types.
+
+**[NotificationPusher](notification-pusher):** Push your notifications to various services. Including [Email](notification-pusher-actionmailer), [ActionCable](notification-pusher-actioncable), [OneSignal](notification-pusher-onesignal).
+
+**[NotificationSettings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
+
+You may just add the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
+
+---
+
 ## Installation
 
 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
 
 We hope that you will consider contributing to NotificationsRails. Please read this short overview for some information about how to get started:
 
-[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)
+[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
 
 ### Contributors
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notification-renderer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-23 00:00:00.000000000 Z
+date: 2017-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta2
+        version: 1.0.0.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta2
+        version: 1.0.0.beta3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.52'
-description: "..."
+description: Render your notifications on multiple platforms by specifying notification
+  types.
 email: jonas.huebotter@gmail.com
 executables: []
 extensions: []
@@ -111,5 +112,6 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: "..."
+summary: Render your notifications on multiple platforms by specifying notification
+  types
 test_files: []