vmware-tanzu / astrolabe

Data protection framework for complex applications
Other
37 stars 21 forks source link

Update README #106

Open eleanor-millman opened 2 years ago

eleanor-millman commented 2 years ago

The README was written when there was no code written. Additionally, we need to add more details on contribution guidelines (see https://tanzucommunityedition.io/docs/latest/contribute/contributing/ as an example).

From https://github.com/vmware-tanzu/community-engagement/blob/main/GUIDELINES.md: The project README should be simple, focused, and mostly bullet item listed with steps to get up and running quickly. The README or landing page should include a project statement (what is does, why it’s important, and how it works), a list of features, screenshots (if a graphical UI exists), contribution guidelines, code of conduct, and links to relevant outside sources. (EXAMPLE).