Skip to content

docs: Revise README for clarity and keep minimal data #725

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 2 commits into from
May 10, 2025
Merged

docs: Revise README for clarity and keep minimal data #725

merged 2 commits into from
May 10, 2025

Conversation

jainmohit2001
Copy link
Collaborator

Changes included in this PR

  • Removed usage docs from the root README and keeping it minimal

Impact

Checklist

  1. Does your submission pass the existing tests?
  2. Are there new tests that cover these additions/changes?
  3. Have you linted your code locally before submission?

@jainmohit2001 jainmohit2001 merged commit 073625d into master May 10, 2025
8 checks passed
@jainmohit2001 jainmohit2001 deleted the cleanup-readme branch May 10, 2025 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mdwcrft mdwcrft mdwcrft approved these changes

@proelke proelke Awaiting requested review from proelke proelke is a code owner

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jainmohit2001 @mdwcrft