Improve README clarity and fix typos #2
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
- 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
2 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
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:
These changes make the documentation more professional and easier to understand for users.
Types of Changes
Checklist
CONTRIBUTING.mddocumentFurther 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.