|
1 |
| -# Overview |
| 1 | +<h1 align="center">Welcome to @onesignal/node-onesignal 👋</h1> |
| 2 | +<p> |
| 3 | + <a href="https://www.npmjs.com/package/@onesignal/node-onesignal" target="_blank"> |
| 4 | + <img alt="Version" src="https://img.shields.io/npm/v/@onesignal/node-onesignal.svg"> |
| 5 | + </a> |
| 6 | + <a href="https://github.com/OneSignal/node-onesignal#readme" 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/node-onesignal/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 | +> OpenAPI client for node-onesignal |
| 18 | +
|
| 19 | +### 🏠 [Homepage](https://github.com/OneSignal/node-onesignal#readme) |
| 20 | +### 🖤 [npm](https://www.npmjs.com/package/@onesignal/node-onesignal) |
| 21 | + |
| 22 | +## 🚧 In Beta 🚧 |
| 23 | +## Overview |
2 | 24 | This is a Node.js wrapper library over OneSignal REST API. You can create notifications, view apps, edit a device and all other actions you can take on OneSignal REST API. Includes Typescript support.
|
3 | 25 |
|
4 |
| -# Installation |
| 26 | +# Install |
5 | 27 |
|
6 |
| -``` |
7 |
| -npm install @onesignal/node-onesignal --save |
8 |
| -``` |
9 |
| - |
10 |
| -``` |
| 28 | +```sh |
| 29 | +// yarn |
11 | 30 | yarn add @onesignal/node-onesignal
|
| 31 | + |
| 32 | +// npm |
| 33 | +npm install @onesignal/node-onesignal --save |
12 | 34 | ```
|
13 | 35 |
|
14 | 36 | # Usage
|
@@ -315,3 +337,23 @@ Outcome Data Limitations Outcomes are only accessible for around 30 days before
|
315 | 337 | ```js
|
316 | 338 | client.getOutcomes(app.id, 'os__click.count,os_session_duration.count,my_outcome.sum');
|
317 | 339 | ```
|
| 340 | + |
| 341 | + |
| 342 | +## Author |
| 343 | + |
| 344 | +* Website: https://onesignal.com |
| 345 | +* Twitter: [@onesignal](https://twitter.com/onesignal) |
| 346 | +* Github: [@OneSignal](https://github.com/OneSignal) |
| 347 | + |
| 348 | +## 🤝 Contributing |
| 349 | + |
| 350 | +Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/OneSignal/node-onesignal/issues). |
| 351 | + |
| 352 | +## Show your support |
| 353 | + |
| 354 | +Give a ⭐️ if this project helped you! |
| 355 | + |
| 356 | +## 📝 License |
| 357 | + |
| 358 | +Copyright © 2022 [OneSignal](https://github.com/OneSignal).<br /> |
| 359 | +This project is [MIT](https://github.com/OneSignal/node-onesignal/blob/main/LICENSE) licensed. |
0 commit comments