-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixed some errors shown from adapter-checker Updated Readme
- Loading branch information
Showing
4 changed files
with
281 additions
and
206 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2023 sestriel <[email protected]> | ||
| Copyright (c) 2023-2024 sestriel <[email protected]> | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,108 +1,39 @@ | ||
|  | ||
| # ioBroker.ntfy | ||
| # ioBroker ntfy.sh adapter | ||
|
|
||
| [](https://www.npmjs.com/package/iobroker.ntfy) | ||
| [](https://www.npmjs.com/package/iobroker.ntfy) | ||
|  | ||
|  | ||
| [](https://www.npmjs.com/package/iobroker.ntfy) [](https://www.npmjs.com/package/iobroker.ntfy)   | ||
|  | ||
|
|
||
| [](https://nodei.co/npm/iobroker.ntfy/) | ||
| Use your ntfy.sh (free selfhosted) server to send and receive push notifications | ||
|
|
||
| **Tests:**  | ||
| * Integrates an Blockly to easily send notifications | ||
| - Currently supported: Title, Message, Priority | ||
| * Subscribe to topics without the need of extra javascript/blockly | ||
| - messages will be pushed to the corresponding, auto-created ioBroker object | ||
| * Send and receive from as many topics as you want | ||
|
|
||
| ## ntfy adapter for ioBroker | ||
|
|
||
| Use your ntfy.sh (free selfhosted) server for Push Notifications | ||
|
|
||
| ## Developer manual | ||
| This section is intended for the developer. It can be deleted later. | ||
|
|
||
| ### DISCLAIMER | ||
|
|
||
| Please make sure that you consider copyrights and trademarks when you use names or logos of a company and add a disclaimer to your README. | ||
| You can check other adapters for examples or ask in the developer community. Using a name or logo of a company without permission may cause legal problems for you. | ||
|
|
||
| ### Getting started | ||
|
|
||
| You are almost done, only a few steps left: | ||
| 1. Create a new repository on GitHub with the name `ioBroker.ntfy` | ||
|
|
||
| 1. Push all files to the GitHub repo. The creator has already set up the local repository for you: | ||
| ```bash | ||
| git push origin main | ||
| ``` | ||
| 1. Add a new secret under https://github.com/sestriel/ioBroker.ntfy/settings/secrets. It must be named `AUTO_MERGE_TOKEN` and contain a personal access token with push access to the repository, e.g. yours. You can create a new token under https://github.com/settings/tokens. | ||
|
|
||
| 1. Head over to [main.js](main.js) and start programming! | ||
|
|
||
| ### Best Practices | ||
| We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should | ||
| check them out. If you're already experienced, you should also take a look at them - you might learn something new :) | ||
| ### Scripts in `package.json` | ||
| Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>` | ||
| | Script name | Description | | ||
| |-------------|-------------| | ||
| | `test:js` | Executes the tests you defined in `*.test.js` files. | | ||
| | `test:package` | Ensures your `package.json` and `io-package.json` are valid. | | ||
| | `test:integration` | Tests the adapter startup with an actual instance of ioBroker. | | ||
| | `test` | Performs a minimal test run on package files and your tests. | | ||
| | `check` | Performs a type-check on your code (without compiling anything). | | ||
| | `lint` | Runs `ESLint` to check your code for formatting errors and potential bugs. | | ||
| | `translate` | Translates texts in your adapter to all required languages, see [`@iobroker/adapter-dev`](https://github.com/ioBroker/adapter-dev#manage-translations) for more details. | | ||
| | `release` | Creates a new release, see [`@alcalzone/release-script`](https://github.com/AlCalzone/release-script#usage) for more details. | | ||
| ### Writing tests | ||
| When done right, testing code is invaluable, because it gives you the | ||
| confidence to change your code while knowing exactly if and when | ||
| something breaks. A good read on the topic of test-driven development | ||
| is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92. | ||
| Although writing tests before the code might seem strange at first, but it has very | ||
| clear upsides. | ||
| The template provides you with basic tests for the adapter startup and package files. | ||
| It is recommended that you add your own tests into the mix. | ||
| ### Publishing the adapter | ||
| Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form | ||
| `v<major>.<minor>.<patch>`. We **strongly recommend** that you do. The necessary steps are described in `.github/workflows/test-and-release.yml`. | ||
| Since you installed the release script, you can create a new | ||
| release simply by calling: | ||
| ```bash | ||
| npm run release | ||
| ``` | ||
| Additional command line options for the release script are explained in the | ||
| [release-script documentation](https://github.com/AlCalzone/release-script#command-line). | ||
| To get your adapter released in ioBroker, please refer to the documentation | ||
| of [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories#requirements-for-adapter-to-get-added-to-the-latest-repository). | ||
| ### Test the adapter manually with dev-server | ||
| Since you set up `dev-server`, you can use it to run, test and debug your adapter. | ||
| You may start `dev-server` by calling from your dev directory: | ||
| ```bash | ||
| dev-server watch | ||
| ``` | ||
| The ioBroker.admin interface will then be available at http://localhost:8081/ | ||
| Please refer to the [`dev-server` documentation](https://github.com/ioBroker/dev-server#command-line) for more details. | ||
| ### Known bugs and errors | ||
| * ntfy has an invalid jsonConfig (see [Issue](https://github.com/ioBroker/adapter-react-v5/issues/292)) | ||
|
|
||
| ## Changelog | ||
| <!-- | ||
| Placeholder for the next version (at the beginning of the line): | ||
| ### **WORK IN PROGRESS** | ||
| --> | ||
| ### **WORK IN PROGRESS** | ||
| * (sestriel) initial release | ||
| ### 0.2.1 (2024-04-12) | ||
| * (sestriel) Added proper unload handler | ||
| * (sestriel) Fixed some errors shown from adapter-checker | ||
| * (sestriel) Updated Readme | ||
| ### 0.2.0 (2024-04-12) | ||
| * (sestriel) Added ability to subscribe to topics | ||
| ### 0.1.2 (2023-10-05) | ||
| * (sestriel) Added presets for more topics | ||
| * (sestriel) Added proper authorization for default topic | ||
| ### 0.1.1 (2023-09-28) | ||
| * (sestriel) First working release | ||
| ### 0.1.0 (2023-09-27) | ||
| * (sestriel) Initial release | ||
|
|
||
| ## License | ||
| MIT License | ||
|
|
||
| Copyright (c) 2023 sestriel <[email protected]> | ||
| Copyright (c) 2023-2024 sestriel <[email protected]> | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
|  | ||
| # ioBroker.ntfy | ||
|
|
||
| [](https://www.npmjs.com/package/iobroker.ntfy) | ||
| [](https://www.npmjs.com/package/iobroker.ntfy) | ||
|  | ||
|  | ||
|
|
||
| [](https://nodei.co/npm/iobroker.ntfy/) | ||
|
|
||
| **Tests:**  | ||
|
|
||
| ## ntfy adapter for ioBroker | ||
|
|
||
| Use your ntfy.sh (free selfhosted) server for Push Notifications | ||
|
|
||
| ## Developer manual | ||
| This section is intended for the developer. It can be deleted later. | ||
|
|
||
| ### DISCLAIMER | ||
|
|
||
| Please make sure that you consider copyrights and trademarks when you use names or logos of a company and add a disclaimer to your README. | ||
| You can check other adapters for examples or ask in the developer community. Using a name or logo of a company without permission may cause legal problems for you. | ||
|
|
||
| ### Getting started | ||
|
|
||
| You are almost done, only a few steps left: | ||
| 1. Create a new repository on GitHub with the name `ioBroker.ntfy` | ||
|
|
||
| 1. Push all files to the GitHub repo. The creator has already set up the local repository for you: | ||
| ```bash | ||
| git push origin main | ||
| ``` | ||
| 1. Add a new secret under https://github.com/sestriel/ioBroker.ntfy/settings/secrets. It must be named `AUTO_MERGE_TOKEN` and contain a personal access token with push access to the repository, e.g. yours. You can create a new token under https://github.com/settings/tokens. | ||
|
|
||
| 1. Head over to [main.js](main.js) and start programming! | ||
|
|
||
| ### Best Practices | ||
| We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should | ||
| check them out. If you're already experienced, you should also take a look at them - you might learn something new :) | ||
|
|
||
| ### Scripts in `package.json` | ||
| Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>` | ||
| | Script name | Description | | ||
| |-------------|-------------| | ||
| | `test:js` | Executes the tests you defined in `*.test.js` files. | | ||
| | `test:package` | Ensures your `package.json` and `io-package.json` are valid. | | ||
| | `test:integration` | Tests the adapter startup with an actual instance of ioBroker. | | ||
| | `test` | Performs a minimal test run on package files and your tests. | | ||
| | `check` | Performs a type-check on your code (without compiling anything). | | ||
| | `lint` | Runs `ESLint` to check your code for formatting errors and potential bugs. | | ||
| | `translate` | Translates texts in your adapter to all required languages, see [`@iobroker/adapter-dev`](https://github.com/ioBroker/adapter-dev#manage-translations) for more details. | | ||
| | `release` | Creates a new release, see [`@alcalzone/release-script`](https://github.com/AlCalzone/release-script#usage) for more details. | | ||
|
|
||
| ### Writing tests | ||
| When done right, testing code is invaluable, because it gives you the | ||
| confidence to change your code while knowing exactly if and when | ||
| something breaks. A good read on the topic of test-driven development | ||
| is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92. | ||
| Although writing tests before the code might seem strange at first, but it has very | ||
| clear upsides. | ||
|
|
||
| The template provides you with basic tests for the adapter startup and package files. | ||
| It is recommended that you add your own tests into the mix. | ||
|
|
||
| ### Publishing the adapter | ||
| Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form | ||
| `v<major>.<minor>.<patch>`. We **strongly recommend** that you do. The necessary steps are described in `.github/workflows/test-and-release.yml`. | ||
|
|
||
| Since you installed the release script, you can create a new | ||
| release simply by calling: | ||
| ```bash | ||
| npm run release | ||
| ``` | ||
| Additional command line options for the release script are explained in the | ||
| [release-script documentation](https://github.com/AlCalzone/release-script#command-line). | ||
|
|
||
| To get your adapter released in ioBroker, please refer to the documentation | ||
| of [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories#requirements-for-adapter-to-get-added-to-the-latest-repository). | ||
|
|
||
| ### Test the adapter manually with dev-server | ||
| Since you set up `dev-server`, you can use it to run, test and debug your adapter. | ||
|
|
||
| You may start `dev-server` by calling from your dev directory: | ||
| ```bash | ||
| dev-server watch | ||
| ``` | ||
|
|
||
| The ioBroker.admin interface will then be available at http://localhost:8081/ | ||
|
|
||
| Please refer to the [`dev-server` documentation](https://github.com/ioBroker/dev-server#command-line) for more details. | ||
|
|
||
| ## Changelog | ||
| <!-- | ||
| Placeholder for the next version (at the beginning of the line): | ||
| ### **WORK IN PROGRESS** | ||
| --> | ||
|
|
||
| ### **WORK IN PROGRESS** | ||
| * (sestriel) initial release | ||
|
|
||
| ## License | ||
| MIT License | ||
|
|
||
| Copyright (c) 2023-2024 sestriel <[email protected]> | ||
|
|
||
| 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: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| 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. |
Oops, something went wrong.