Skip to content

Commit 0d4d6ab

Browse files
authored
Update README.md (#2007)
* Update README.md * Update README.md
1 parent 789e0ab commit 0d4d6ab

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

packages/examples/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ Some command line parameters, for example those used to set the level of logging
5252
* `--mdns-networkinterface=...` or environment variable `MATTER_MDNS_NETWORKINTERFACE` or `environment.vars.set('mdns.networkInterface', "...")` allows to limit the DNS announcements and scanning to one network interface. By default, all available interfaces are used.
5353
Additionally, all command line parameters now require to start with two dashes!
5454

55+
(if using `npm run ...` to run examples then an additional "--" if needed to separate commandline parameters between the npm run and the executed script. Please see the relevant examples README too.)
56+
5557
## Development on basis of the examples
5658

5759
The code of the examples is written so that you can use them as basis for your own scripts also outside of this library in your own package. If you import from `@matter/main` then matter.js loads platform extensions such as those for node.js automatically. If you import directly from our other packages then you should add a dependency on `@matter/nodejs`. The examples use `@matter/main` imports to ease adoption.

packages/examples/src/device-onoff/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ or when starting from TS files:
3333
```bash
3434
npm run matter-device -- --type socket --on="echo 255 > /sys/class/leds/led1/brightness" --off="echo 0 > /sys/class/leds/led1/brightness"
3535
```
36-
(Please note the "--" to separate commandline parameters between the npm run and the executed script.
36+
(Please note the "--" to separate commandline parameters between the npm run and the executed script.)
3737

3838
**If you want to start multiple parallel processes please make sure to use different storage locations, different network port and ideally also different passcodes for each process!**
3939

0 commit comments

Comments
 (0)