Merge pull request #11 from OneSignal/update-repo

Repo maintenance updates

Author: rgomezp

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## January 2022
+
+### `1.0.0-beta4` - 02/25/2022
+#### Added
+- .npmignore file
+
+#### Fixed
+- Missing `dist` directory since npm was ignoring it due to lack of .npmignore

LICENSE

@@ -0,0 +1,24 @@
+Modified MIT License
+
+Copyright 2022 OneSignal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+1. The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+2. All copies of substantial portions of the Software may only be used in connection
+with services provided by OneSignal.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,14 +1,36 @@
-# Overview
+<h1 align="center">Welcome to @onesignal/node-onesignal 👋</h1>
+<p>
+  <a href="https://www.npmjs.com/package/@onesignal/node-onesignal" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/@onesignal/node-onesignal.svg">
+  </a>
+  <a href="https://github.com/OneSignal/node-onesignal#readme" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+  <a href="https://github.com/OneSignal/node-onesignal/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>
+
+> OpenAPI client for node-onesignal
+
+### 🏠 [Homepage](https://github.com/OneSignal/node-onesignal#readme)
+### 🖤 [npm](https://www.npmjs.com/package/@onesignal/node-onesignal)
+
+## 🚧 In Beta 🚧
+## Overview
 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.
 
-# Installation
+# Install
 
-```
-npm install @onesignal/node-onesignal --save
-```
-
-```
+```sh
+// yarn
 yarn add @onesignal/node-onesignal
+
+// npm
+npm install @onesignal/node-onesignal --save
 ```
 
 # Usage
@@ -315,3 +337,23 @@ Outcome Data Limitations Outcomes are only accessible for around 30 days before
 ```js
 client.getOutcomes(app.id, 'os__click.count,os_session_duration.count,my_outcome.sum');
 ```
+
+
+## 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/node-onesignal/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://github.com/OneSignal/node-onesignal/blob/main/LICENSE) licensed.

RELEASE_INSTRUCTIONS.md

@@ -0,0 +1,10 @@
+# Release Instructions
+
+1. Update version in package.json
+2. Update README.md with updated version number in version shield
+3. Document changes in CHANGELOG.md
+4. Merge changes into main branch
+5. Run `git pull` from local `main`
+5. Run `npm publish .`
+6. Draft a release
+

package.json

@@ -3,12 +3,17 @@
   "version": "1.0.0-beta4",
   "description": "OpenAPI client for node-onesignal",
   "author": "rgomezp",
+  "homepage": "https://github.com/OneSignal/node-onesignal#readme",
   "keywords": [
     "typescript",
     "node",
     "openapi-client",
     "openapi-generator"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OneSignal/node-onesignal"
+  },
   "license": "MIT",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
@@ -17,15 +22,16 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "node-fetch": "^2.6.0",
-    "@types/node-fetch": "^2.5.7",
     "@types/node": "*",
-    "form-data": "^2.5.0",
+    "@types/node-fetch": "^2.5.7",
     "btoa": "^1.2.1",
     "es6-promise": "^4.2.4",
+    "form-data": "^2.5.0",
+    "node-fetch": "^2.6.0",
     "url-parse": "^1.4.3"
   },
   "devDependencies": {
+    "readme-md-generator": "^1.0.0",
     "typescript": "^3.9.3"
   }
 }