From ca90232c9afbf50176201c36559a6b3121b6b3c1 Mon Sep 17 00:00:00 2001 From: Joan Edwards <42442393+joaedwar@users.noreply.github.com> Date: Mon, 8 Jul 2019 07:41:33 +0100 Subject: [PATCH] Small grammatical correction for README.md (#237) * Small grammatical correction for README.md * Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ddc3f4e9f..6c67b9ef8 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # Knative Client -Knative developer experience best practices, reference Knative CLI -implementation, and reference Knative client libraries. +This section outlines best practices for the Knative developer experience, is a reference for Knative CLI +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 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 -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 -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) * [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:** -Run following to enable bash auto completion +Run the following command to enable BASH auto-completion: ```sh $ source <(kn completion) ``` -Use TAB to list available sub-commands +Use TAB to list available sub-commands: ```sh $ kn @@ -39,7 +39,7 @@ describe get # Developers -If you'd like to contribute, please see +If you would like to contribute, please see [CONTRIBUTING](https://knative.dev/contributing/) for more information.