Uploaded image for project: 'OpenShift CFE'
  1. OpenShift CFE
  2. CFE-99

Docs: Improve ReadMe

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • 2021Q3 Plan
    • None
    • must-gather-clean
    • None
    • CFE Sprint 207

      We need to add some more information about the CLI, what the purpose is, what the key features are and how we can download + install it.

      Extra points: additional information on defining the schema would be useful, also more examples to explain along.

      You can get inspired to what ODO has: https://github.com/openshift/odo#odo---developer-focused-cli-for-kubernetes-and-openshift

      AC:

      • README.md should cover key features, purpose and functionality we support and how to configure it along with examples
      • README.md should cover steps to download and install binaries (pending on CFE-97)

              tjungblu@redhat.com Thomas Jungblut
              tjungblu@redhat.com Thomas Jungblut
              Thomas Jungblut
              Thomas Jungblut
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: