Skip to content

Add Usage information and code samples to README #16

Closed
@mpospese

Description

@mpospese

Intro

Our README should contain all necessary summary information about our framework. Currently we're missing usage information.

Task

Copy the usage information from this Notion page (restricted) into the README. Add a new h2 section "Usage" and place that information within (using h3 and h4 subsections as appropriate). The "Usage" section should be between "Documentation" and "Installation". Do not copy over the section with the video links (because those are private).

AC

  • README updated with all usage information

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