[EASY PR] Update README.md for spelling and grammar clarity

waiting-for-dev / devise-jwt

JWT token authentication with devise and rails

MIT License

1.25k stars 129 forks source link

[EASY PR] Update README.md for spelling and grammar clarity #249

Closed Syed-Naufal-Mahmood closed 2 years ago

Syed-Naufal-Mahmood commented 2 years ago

Fix spelling errors
Change wording and sentence structure for clarity
Standardized capitalization of Devise, since it is capitalized in their documentation
Add table of contents to provide an overview of document and for quick traversal

waiting-for-dev commented 2 years ago

Thanks! I appreciate it :slightly_smiling_face:

I'm in favor of all the small changes, but I prefer not having to maintain a TOC. Remember that GH does that automatically (icon on the left of README.md):

![Uploading screenshot-github.com-2022.07.16-09_35_54.png…]()

Syed-Naufal-Mahmood commented 2 years ago

Thanks for responding! I actually didn't know GH provides the TOC automatically, you learn something new everyday. I have added another commit that removes the TOC changes.

waiting-for-dev commented 2 years ago

Thanks, @Syed-Naufal-Mahmood!