diff --git a/README.md b/README.md index cfc99df..e829538 100644 --- a/README.md +++ b/README.md @@ -14,90 +14,6 @@ Connects to the Jablotron cloud to access your security system -## Developer manual -References -* https://github.com/ioBroker/AdapterRequests/issues/755 -* https://github.com/hajekmi/myjablotron -* https://github.com/fdegier/homebridge-jablotron-alarm - -### 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.jablotron` - -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/DEV2DEV-DE/ioBroker.jablotron/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 ` -| 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..`. 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 on a local ioBroker installation -In order to install the adapter locally without publishing, the following steps are recommended: -1. Create a tarball from your dev directory: - ```bash - npm pack - ``` -1. Upload the resulting file to your ioBroker host -1. Install it locally (The paths are different on Windows): - ```bash - cd /opt/iobroker - npm i /path/to/tarball.tgz - ``` - -For later updates, the above procedure is not necessary. Just do the following: -1. Overwrite the changed files in the adapter directory (`/opt/iobroker/node_modules/iobroker.jablotron`) -1. Execute `iobroker upload jablotron` on the ioBroker host - ## Changelog ### 0.0.2-alpha.2 (2023-11-27) Enabled automatic releases on NMP