fix(doc): grammar and readability improvements in README #5
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
Some grammar fixes and readability improvements. Mostly in the *Usage* section, as well as in the opening sentence. I would also like to suggest changing the repository description to read more like this: "Neovim plugin template with integration for tests, linting, and doc publishing" (Currently it reads, "neovim plugin template integration test and doc publish") Lastly, I would like to suggest adding some tags to this repo, which would improve its visibility. Something like `neovim-plugin-template`, as well as `template` would go well. It might be worth checking if there are any other plugin templates that have tags you could borrow. Thanks for your work on this!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Some grammar fixes and readability improvements. Mostly in the Usage section, as well as in the opening sentence.
I would also like to suggest changing the repository description to read more like this:
"Neovim plugin template with integration for tests, linting, and doc publishing"
(Currently it reads, "neovim plugin template integration test and doc publish")
Lastly, I would like to suggest adding some tags to this repo, which would improve its visibility. Something like
neovim-plugin-template, as well astemplatewould go well. It might be worth checking if there are any other plugin templates that have tags you could borrow.Thanks for your work on this!