You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-78Lines changed: 4 additions & 78 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,87 +14,13 @@
14
14
15
15
Reads data from the SofarCloud server
16
16
17
-
## Developer manual
18
-
This section is intended for the developer. It can be deleted later.
19
-
20
-
### DISCLAIMER
21
-
22
-
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.
23
-
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.
24
-
25
-
### Getting started
26
-
27
-
You are almost done, only a few steps left:
28
-
1. Clone the repository from GitHub to a directory on your PC:
1. Head over to [main.js](main.js) and start programming!
34
-
35
-
### Best Practices
36
-
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
37
-
check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
38
-
39
-
### Scripts in `package.json`
40
-
Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
41
-
| Script name | Description |
42
-
|-------------|-------------|
43
-
| `test:js` | Executes the tests you defined in `*.test.js` files. |
44
-
| `test:package` | Ensures your `package.json` and `io-package.json` are valid. |
45
-
| `test:integration` | Tests the adapter startup with an actual instance of ioBroker. |
46
-
| `test` | Performs a minimal test run on package files and your tests. |
47
-
| `check` | Performs a type-check on your code (without compiling anything). |
48
-
| `lint` | Runs `ESLint` to check your code for formatting errors and potential bugs. |
49
-
| `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. |
50
-
| `release` | Creates a new release, see [`@alcalzone/release-script`](https://github.com/AlCalzone/release-script#usage) for more details. |
51
-
52
-
### Writing tests
53
-
When done right, testing code is invaluable, because it gives you the
54
-
confidence to change your code while knowing exactly if and when
55
-
something breaks. A good read on the topic of test-driven development
56
-
is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92.
57
-
Although writing tests before the code might seem strange at first, but it has very
58
-
clear upsides.
59
-
60
-
The template provides you with basic tests for the adapter startup and package files.
61
-
It is recommended that you add your own tests into the mix.
62
-
63
-
### Publishing the adapter
64
-
Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form
65
-
`v<major>.<minor>.<patch>`. We **strongly recommend** that you do. The necessary steps are described in `.github/workflows/test-and-release.yml`.
66
-
67
-
Since you installed the release script, you can create a new
68
-
release simply by calling:
69
-
```bash
70
-
npm run release
71
-
```
72
-
Additional command line options for the release script are explained in the
0 commit comments