Improved the project's README.md file #166
Open
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
|
@DaveHealS is attempting to deploy a commit to the Jmperez Team Team on Vercel. A member of the Team first needs to authorize it. |
- For easier readability, a table of content was added at the top of the readme. - A new Badge now displays the amount of open issues. This helps new people see the amount of chances to contribute. - Rewrote introduction to outline the project more clearly - To highlight the features of this project, a new feature section was created. - To visualize and give a quick tutorial on the project's workflow, a guide was added. - To help new people with the installation process, more detailled commands were added. This includes the installation of the required pnpm, as well as needed git commands - To standardize other user's contributions to this project, a new section was created in the readme. It includes needed commands as well as a tip concerning large changes - For better visibility, a link to the license was added at the bottom of the readme.
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.
I rewrote the README.md to better outline the project's features and help new people contribute and use spotify-dedup.
Here is a list of changes done: