Skip to content

Adjust README.md and remove guide to install using direkt native npm command #1190

@mcm1957

Description

@mcm1957

README.md for a new adapter contains the following section:

Test the adapter manually on a local ioBroker installation
In order to install the adapter locally without publishing, the following steps are recommended:

Create a tarball from your dev directory:
npm pack
Upload the resulting file to your ioBroker host
Install it locally (The paths are different on Windows):
cd /opt/iobroker
npm i /path/to/tarball.tgz
For later updates, the above procedure is not necessary. Just do the following:

Overwrite the changed files in the adapter directory (/opt/iobroker/node_modules/iobroker.test-adapter)
Execute iobroker upload test-adapter on the ioBroker host

Should be really guide a NEW developer to direct npm intallations?

current admin admin and commandline bioth can install directly from a github repository or a tarball (or as far as I know even from a local directory). So shouldn't be use something like

iobroker url mytarball.tgz

or even better to link to the github repo?

And in addition the required iob upload should be mentioned there too. New users will likely forget ist - and those instructions are for sure only related to new devs.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions