Update README #4
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
docs: Improve README formatting for GitHub Pages compatibility - Added structured headings for better readability - Included prerequisite installation steps for clarity - Extended installation instructions to include dependency installation and API key configuration - Reformatted code blocks using shell (`sh`) and Python for proper syntax highlighting - Enhanced plugin development section with clear instructions - Added contributing guidelines for streamlined pull requests This update aims to make the README more user-friendly and approachable to new developers.
added links to overview
|
This README update is for a project I'm doing for one of my university classes, and I'm still learning how to use github to its fullest! If there are any problems or changes that need to be done, please let me know. |
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.
sh) and Python for proper syntax highlightingThis update aims to make the README more user-friendly and approachable to new developers.