Skip to content

Commit 63f1293

Browse files
committed
Update README.md
1 parent bd4364e commit 63f1293

1 file changed

Lines changed: 40 additions & 4 deletions

File tree

README.md

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
1-
# onesignal
1+
<h1 align="center">Welcome to the official OneSignal Ruby Client 👋</h1>
22

33
[![Gem Version][rgb]][rgl]
44

5+
<p>
6+
<a href="https://github.com/OneSignal/onesignal-ruby-client/blob/master/README.md" target="_blank">
7+
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
8+
</a>
9+
<a href="https://github.com/OneSignal/onesignal-ruby-client/graphs/commit-activity" target="_blank">
10+
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
11+
</a>
12+
<a href="https://twitter.com/onesignal" target="_blank">
13+
<img alt="Twitter: onesignal" src="https://img.shields.io/twitter/follow/onesignal.svg?style=social" />
14+
</a>
15+
</p>
16+
17+
518
OneSignal - the Ruby gem for the OneSignal
619

720
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
1023

1124
OneSignal is a simple ruby wrapper for the [OneSignal API][osa].
1225

26+
### 🖤 [RubyGems](https://rubygems.org/gems/onesignal)
27+
28+
## 🚧 In Beta 🚧
29+
1330
## Installation
1431

1532
Add this line to your application's Gemfile:
@@ -37,12 +54,12 @@ require 'onesignal'
3754
# Setup authorization
3855
OneSignal.configure do |config|
3956
# Configure Bearer authorization: app_key
40-
config.access_token = 'YOUR_BEARER_TOKEN'
57+
config.access_token = 'YOUR BEARER TOKEN'
4158
end
4259

4360
api_instance = OneSignal::DefaultApi.new
44-
app_id = 'app_id_example' # String |
45-
notification_id = 'notification_id_example' # String |
61+
app_id = 'APP ID EXAMPLE' # String |
62+
notification_id = 'NOTIFICATION ID EXAMPLE' # String |
4663

4764
begin
4865
#Stop a scheduled or currently outgoing notification
@@ -139,3 +156,22 @@ The gem is available as open source under the terms of the [MIT License][mit].
139156
[rgl]: https://rubygems.org/gems/onesignal
140157
[osa]: https://documentation.onesignal.com/reference/
141158
[mit]: http://opensource.org/licenses/MIT
159+
160+
## Author
161+
162+
* Website: https://onesignal.com
163+
* Twitter: [@onesignal](https://twitter.com/onesignal)
164+
* Github: [@OneSignal](https://github.com/OneSignal)
165+
166+
## 🤝 Contributing
167+
168+
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/OneSignal/onesignal-ruby-client/issues).
169+
170+
## Show your support
171+
172+
Give a ⭐️ if this project helped you!
173+
174+
## 📝 License
175+
176+
Copyright © 2022 [OneSignal](https://github.com/OneSignal).<br />
177+
This project is [MIT](https://opensource.org/licenses/MIT) licensed.

0 commit comments

Comments
 (0)