shifu icon indicating copy to clipboard operation
shifu copied to clipboard

Published 20 hours ago • verified publisher icon Edgenesis

[WIP] Improve README to make it more intuitive

Open saiyan86 opened this issue 2 years ago • 0 comments

What this PR does / why we need it: Improve README to make it more intuitive. Before this PR, README is a little bit confusing. This PR should give readers a lot mroe clarity.

Will this PR make the community happier? Yes, but only after it's finished : )

Which issue this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close that issue when PR gets merged): fixes #

Special notes for your reviewer: @Yang-Xijie please proceed with the PR, and address the following tasks:

  1. translate the new README into Chinese.
  2. In If you have a running Kubernetes cluster section, provide a way to install/uninstall Shifu Demo. Currently after this section we only have Shifu installed, but we don't know what does Shifu do.

Release note:

saiyan86 avatar Aug 23 '22 03:08 saiyan86