docs: update README.md

[siggiskulason]

Signed-off-by: Siggi Skulason siggi.skulason@canonical.com

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-cli/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

• I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
• I am not introducing a new dependency (add notes below if you are)
• I have added unit tests for the new feature or bug fix (if not, why?) N/A
• I have fully tested (add details below) this the new feature or bug fix (if not, why?) N/A
• I have opened a PR for the related docs change (if not, why?) N/A

Testing Instructions

N/A

New Dependency Instructions (If applicable)

[MonicaisHer]

Could we also add a section here? This is based on this ADR.

Supported commands and sub-commands

Core Command

• edgex-cli command read | write | list

Core Data

• edgex-cli event add | list | rm
• edgex-cli reading count | list
• edgex-cli config

Metadata

• edgex-cli device add | adminstate | list | operstate | rm | update
• edgex-cli deviceprofile add | list | rm | update
• edgex-cli deviceservice add | list | rm | update
• edgex-cli provisionwatcher add | list | rm | update

Support Notifications

• edgex-cli notification add | list | rm
• edgex-cli subscription add | list | rm
• edgex-cli config

Support Scheduler

• edgex-cli interval add | list | rm | update
• edgex-cli intervalaction get | list | rm | update
• edgex-cli transmission list | rm

Common endpoints in all services

• edgex-cli version
• edgex-cli ping
• edgex-cli metrics

[siggiskulason]

I would rather keep this read me short and put this in the getting started documentation, which I'm working on. Otherwise we end up with documentation in two places and have to keep both up to date. Does that sound ok?

[MonicaisHer]

Sounds great! Thank you.

[farshidtz]

I suggest completely removing the second sentence or changing it to only say that the CLI acts as a wrapper for the REST APIs.

[siggiskulason]

Removed - and updated

[farshidtz]

It is useful for the developers to know what are the functional CLI limitations, i.e. for what actions they still need to rely on the networking APIs. I suggest adding a section to list the limitations and link to appropriate issues. If the list is long, it could instead be a link to enhancement issues for the sake of maintainability.

[siggiskulason]

@farshidtz / @MonicaisHer I added a 2nd commit with a couple of changes as per the comments. Please re-review, thanks!

[farshidtz]

v.1 - > v1

[siggiskulason]

fixed (with a force-push as it was a minor change).

[siggiskulason]

command-line should have a hyphen ( https://en.wikipedia.org/wiki/Command-line_interface ), whereas "EdgeX CLI" doesn't and edgex-cli does (being the actual command name)

[farshidtz]

Thanks. It looks good.

[MonicaisHer]

LGTM, thanks a lot! @siggiskulason