-
Notifications
You must be signed in to change notification settings - Fork 26
docs: update README.md #426
docs: update README.md #426
Conversation
Signed-off-by: Siggi Skulason <siggi.skulason@canonical.com>
make build | ||
./bin/edgex-cli | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds great! Thank you.
README.md
Outdated
@@ -3,6 +3,30 @@ | |||
|
|||
## Introduction | |||
|
|||
A command line interface to interact with EdgeX microservices. Replaces the need to manually construct complex CURL commands and/or maintain developer scripts. | |||
EdgeX-CLI is a command line interface tool meant for developers to interact with EdgeX microservices. It replaces the need to manually construct complex cURL commands and/or maintain developer scripts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest completely removing the second sentence or changing it to only say that the CLI acts as a wrapper for the REST APIs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed - and updated
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. |
@farshidtz / @MonicaisHer I added a 2nd commit with a couple of changes as per the comments. Please re-review, thanks! |
README.md
Outdated
## Limitations | ||
- The client requires all services to run on the local host. It does not support a distributed configuration or using the API gateway ([#427](https://github.com/edgexfoundry/edgex-cli/issues/427)) | ||
- The `db` command from the v.1 client is not supported ([#383](https://github.com/edgexfoundry/edgex-cli/issues/383)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
v.1 - > v1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed (with a force-push as it was a minor change).
Signed-off-by: Siggi Skulason <siggi.skulason@canonical.com>
command-line should have a hyphen ( https://en.wikipedia.org/wiki/Command-line_interface ), whereas "EdgeX CLI" doesn't and |
Signed-off-by: Siggi Skulason <siggi.skulason@canonical.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. It looks good.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks a lot! @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:
BREAKING CHANGE:
describing the break)Testing Instructions
N/A
New Dependency Instructions (If applicable)