knative
/
client
mirror of https://github.com/knative/client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Small grammatical correction for README.md (#237) 

* Small grammatical correction for README.md

* Update README.md
This commit is contained in:
Joan Edwards 2019-07-08 07:41:33 +01:00 committed by Knative Prow Robot
parent 38a4a6fc18
commit ca90232c9a
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,19 +1,19 @@
# Knative Client # Knative Client
Knative developer experience best practices, reference Knative CLI This section outlines best practices for the Knative developer experience, is a reference for Knative CLI
implementation, and reference Knative client libraries. implementation, and a reference for Knative client libraries.
Goals: The goals of the Knative Client are to:
1. Follow closely the Knative [serving](https://github.com/knative/serving) and [eventing](https://github.com/knative/eventing) APIs 1. Follow the Knative [serving](https://github.com/knative/serving) and [eventing](https://github.com/knative/eventing) APIs
2. Be scriptable to allow users to create different Knative workflows 2. Be scriptable to allow users to create different Knative workflows
3. Expose useful Golang packages to allow integration into other programs or CLIs or plugins 3. Expose useful Golang packages to allow integration into other programs or CLIs or plugins
4. Use consistent verbs, nouns, and flags for various commands 4. Use consistent verbs, nouns, and flags for various commands
5. Be easily extended via a plugin mechanism (similar to Kubectl) to allow for experimentations and customization 5. Be easily extended via a plugin mechanism (similar to `kubectl`) to allow for experimentation and customization
# Docs # Docs
Start with the [user's guide](docs/README.md) and from there you can read about common use cases, get detail docs on each command, and even how to extend the `kn` CLI. Links below for easy access. Start with the [user's guide](docs/README.md) to learn more. You can read about common use cases, get detailed documentation on each command, and learn how to extend the `kn` CLI. For more information, access the following links:
* [User's guide](docs/README.md) * [User's guide](docs/README.md)
* [Basic workflows](docs/workflows.md) (use cases) * [Basic workflows](docs/workflows.md) (use cases)
@ -21,13 +21,13 @@ Start with the [user's guide](docs/README.md) and from there you can read about
**Bash auto completion:** **Bash auto completion:**
Run following to enable bash auto completion Run the following command to enable BASH auto-completion:
```sh ```sh
$ source <(kn completion) $ source <(kn completion)
``` ```
Use TAB to list available sub-commands Use TAB to list available sub-commands:
```sh ```sh
$ kn <TAB> $ kn <TAB>
@ -39,7 +39,7 @@ describe get
# Developers # Developers
If you'd like to contribute, please see If you would like to contribute, please see
[CONTRIBUTING](https://knative.dev/contributing/) [CONTRIBUTING](https://knative.dev/contributing/)
for more information. for more information.