Merge pull request #8 from OneSignal/update-repo

Repo maintenance updates

Author: rgomezp

CHANGELOG.md

@@ -2,6 +2,15 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.0.beta1] - 2021-10-13
+### Major Release
+**INCLUDES BREAKING CHANGES**
+This release is the code-generated Ruby client made with OpenAPI Generator.
+The release is a complete overhaul and includes a new API.
+See README for full documentation.
+
+**Full Changelog**: https://github.com/OneSignal/onesignal-ruby-client/compare/v0.3.0...1.0.0.beta1
+
 ## [0.3.0] - 2016-05-10
 ### Added
 * Models dynamically create attributes on initialization

README.md

@@ -1,7 +1,20 @@
-# onesignal
+<h1 align="center">Welcome to the official OneSignal Ruby Client 👋</h1>
 
 [![Gem Version][rgb]][rgl]
 
+<p>
+  <a href="https://github.com/OneSignal/onesignal-ruby-client/blob/master/README.md" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+  <a href="https://github.com/OneSignal/onesignal-ruby-client/graphs/commit-activity" target="_blank">
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+  </a>
+  <a href="https://twitter.com/onesignal" target="_blank">
+    <img alt="Twitter: onesignal" src="https://img.shields.io/twitter/follow/onesignal.svg?style=social" />
+  </a>
+</p>
+
+
 OneSignal - the Ruby gem for the OneSignal
 
 A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
@@ -10,6 +23,10 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 
 OneSignal is a simple ruby wrapper for the [OneSignal API][osa].
 
+### 🖤 [RubyGems](https://rubygems.org/gems/onesignal)
+
+## 🚧 In Beta 🚧
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,32 +43,32 @@ Or install it yourself as:
 
     $ gem install onesignal --pre
 
+Or install from Github:
+    $ gem "onesignal", '~> 1.0.0.beta1', git: 'git://github.com/OneSignal/onesignal-ruby-client.git'
+
 ## Getting Started
 
 Please follow the [installation](#installation) procedure and then run the following code:
 
 ```ruby
-# Load the gem
+require 'time'
 require 'onesignal'
-
-# Setup authorization
+# setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: app_key
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  config.access_token = 'YOUR BEARER TOKEN' # Change this
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = 'app_id_example' # String | 
-notification_id = 'notification_id_example' # String | 
+notification = OneSignal::Notification.new({app_id: 'YOUR APP ID'}) # Notification
 
 begin
-  #Stop a scheduled or currently outgoing notification
-  result = api_instance.cancel_notification(app_id, notification_id)
+  # Create notification
+  result = api_instance.create_notification(notification)
   p result
 rescue OneSignal::ApiError => e
-  puts "Exception when calling DefaultApi->cancel_notification: #{e}"
+  puts "Error when calling DefaultApi->create_notification: #{e}"
 end
-
 ```
 
 ## Documentation for API Endpoints
@@ -139,3 +156,22 @@ The gem is available as open source under the terms of the [MIT License][mit].
 [rgl]: https://rubygems.org/gems/onesignal
 [osa]: https://documentation.onesignal.com/reference/
 [mit]: http://opensource.org/licenses/MIT
+
+## Author
+
+* Website: https://onesignal.com
+* Twitter: [@onesignal](https://twitter.com/onesignal)
+* Github: [@OneSignal](https://github.com/OneSignal)
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/OneSignal/onesignal-ruby-client/issues).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+Copyright © 2022 [OneSignal](https://github.com/OneSignal).<br />
+This project is [MIT](https://opensource.org/licenses/MIT) licensed.

RELEASE_INSTRUCTIONS.md

@@ -0,0 +1,9 @@
+# Release Instructions
+1. Generate new client version using OpenApi Generator
+2. Create a new PR and merge
+   * Carefully review the PR to ensure nothing is overwritten and you are including all desired changes
+   * Ensure the correct version number is being sent in the header params `OS-Usage-Data` (`api_client.rb`)
+3. Publish to RubyGems
+   * To publish version 0.1.0 of a new gem called 'squid-utils', run: `gem push squid-utils-0.1.0.gem`
+   * To publish a beta version, simply add `.beta1`, `.beta2` etc... after the semantic version (e.g: `1.0.0.beta1`)
+