YT-Spammer-Purge
YT-Spammer-Purge copied to clipboard
Readme changes
Related Issue/Addition to code
This modifies the readme, making it more beautiful, and also moves screenshots down. It also has a simplified install step.
Type of change
- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
Proposed Changes
- Simplify the install process, having one section
- Delete the api key reminder in usage notes, just have in the install process.
- Has a little centered description at the start
- Move screenshots to the last parts
- Beautification all-together
Why is this change needed?
It's needed because the readme has waaaaay to clutter, and is not clear and concise in giving the project info.
Additional Info
- Simplify the install process, having one section. This just makes it easier to install it.
- Deleate the api key reminder in usage notes, just have in the install process. Why 2? 1 is just fine.
- Has a little centered description at the start. This is to have a clear and concise explanation of what the software does.
- Move screenshots to the last parts. People don't want to see screenshots immodestly, they just want to see how to install it and use it.
- Beautification all-together. Explains it by itself.
Checklist:
- [x] My code follows the style guidelines of this project and I have read CONTRIBUTING.md
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] Any dependent changes have been merged and published in downstream modules
- [x] I have checked my code and corrected any misspellings