Skip to content
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.

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

fix: rewrite readme #400

Merged
merged 2 commits into from Dec 27, 2023
Merged

fix: rewrite readme #400

merged 2 commits into from Dec 27, 2023

Conversation

Princesseuh
Copy link
Member

Changes

Some users complained about the README being unclear, this hopefully helps with that

Testing

N/A

Docs

It's docs!

Copy link

changeset-bot bot commented Dec 27, 2023

⚠️ No Changeset found

Latest commit: 0adb142

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Hey @Princesseuh ! What you wrote was absolutely fine, but I'm not sure it was significantly different from what you had before. If the issue was that people were saying it might have been confusing, then maybe we take a bigger swing at it.

If so, below is something you could try. And, I even think you might not need to put it behind a note at all. See what you think, or if that gives you some ideas!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@Princesseuh Princesseuh merged commit 4354afd into main Dec 27, 2023
5 checks passed
@Princesseuh Princesseuh deleted the fix/clarify-readme branch December 27, 2023 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants