Skip to content

Update README #106

@eleanor-millman

Description

@eleanor-millman

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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions