Skip to content

Improve README clarity and fix typos #2

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
Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Improve README clarity and fix typos #2

wants to merge 1 commit into from

Conversation

wxwsir
Copy link
Owner

@wxwsir wxwsir commented May 25, 2025 •
edited
Loading

Proposed Changes

This pull request improves the clarity and readability of the README.adoc file by fixing several typos and making the language more consistent and user-friendly.

The changes include:

  • Fixed grammar error: "This client releases" → "These client releases"
  • Clarified unclear pronoun: "They require" → "The client libraries require"
  • Improved wording consistency: "from JShell" → "using JShell", "or more" → "or higher"
  • Made license section more direct: "the user can" → "you can"
  • Fixed minor wording: "into a commercial" → "in a commercial"

These changes make the documentation more professional and easier to understand for users.

Types of Changes

  • Documentation (correction or otherwise)
  • Cosmetics (whitespace, appearance)

Checklist

  • I have read the CONTRIBUTING.md document
  • All tests pass locally with my changes (no functional changes made)
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in related repositories

Further Comments

These are minor documentation improvements that enhance readability without changing any functionality. The changes follow standard grammar and style conventions to make the README more professional and user-friendly.

@openhands-agent
Improve README clarity and fix typos
4b32d29 
- Fix grammar: 'This client releases' -> 'These client releases'
- Clarify pronoun: 'They require' -> 'The client libraries require'
- Improve wording: 'from JShell' -> 'using JShell', 'or more' -> 'or higher'
- Make license section more direct: 'the user can' -> 'you can'
- Fix minor wording: 'into a commercial' -> 'in a commercial'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
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
@wxwsir @openhands-agent