open-cluster-management-io / addon-framework

addon apis
Apache License 2.0
23 stars 40 forks source link

update readme and doc #68

Closed zhiweiyin318 closed 2 years ago

zhiweiyin318 commented 2 years ago

Signed-off-by: Zhiwei Yin zyin@redhat.com

zhiweiyin318 commented 2 years ago

/assign @qiujian16

qiujian16 commented 2 years ago

I am thinking just put the readme doc under the example directory and have link on top readme

zhiweiyin318 commented 2 years ago

@qiujian16 I moved the example readme to the examples dir, and added some other parts in the repo readme. please review.

openshift-ci[bot] commented 2 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiujian16, zhiweiyin318

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/open-cluster-management-io/addon-framework/blob/main/OWNERS)~~ [qiujian16] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment