APS-2673: Changes to Readme.md and contribute.md #116
Merged
Conversation
This file contains 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
added 4 commits
July 29, 2024 10:56
APS-2673, Removed the old URLs and added the correct one. Formatted the headers and content.
APS-2673, Removed the build badge
rustyjux
requested changes
Jul 29, 2024
There was a problem hiding this comment.
Please review the provided suggestions.
Some of these are maybe a bit of a style thing but I think readme's are very much the place to be concise and not overly wordy.
E.g. see https://github.com/netlify/cli, https://github.com/Shopify/cli - this is a place where short and sweet (but adequately comprehensive content-wise) is best.
APS-2673, Incorporated the PR comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Following changes are done.
Renamed the current readme.md file to contribute.md
Created a new readme.md and following changes are done in it:
Added a title
Added description
Added installation section
Added usage section