Skip to content

docs: Create the first version of README.md #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Oct 31, 2024
Merged

docs: Create the first version of README.md #83

merged 3 commits into from
Oct 31, 2024

Conversation

nanyi-deng
Copy link
Contributor

Linked issue/ticket

#31

Description

Create the first version of README.md for our product users and upload relevant images under readmeAssets.

Reproduction steps

Preview the README.md

Checklist

  • I've followed the Contributing guidelines
  • I've titled my PR according to the Conventional Commits spec
  • I've added tests that fail without this PR but pass with it
  • I've linted, tested, and commented my code
  • I've updated documentation (if appropriate)

@aidanprior aidanprior self-requested a review October 31, 2024 19:04
aidanprior
aidanprior approved these changes Oct 31, 2024
View reviewed changes
Copy link
Collaborator

@aidanprior aidanprior left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great Nancy! Good work

@aidanprior aidanprior merged commit 81bbfbb into dev Oct 31, 2024
3 checks passed
@aidanprior aidanprior deleted the readme branch October 31, 2024 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aidanprior aidanprior aidanprior approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nanyi-deng @aidanprior