Improved Documentation: Installation Guide, Configuration Options, and Contributing Steps #53
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
Improved docs
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.
This pull request enhances the README.md for the Selection.js project by adding detailed sections on installation, usage, and configuration options. Updates including:
A clear installation guide with links to download the script.
A detailed usage section with basic and advanced setup examples.
A comprehensive configuration options table for easy reference.
Improved contributing guidelines, outlining the steps to fork, clone, and submit a pull request.
A preview of the result with explanations for easy testing.
These changes aim to make the documentation more user-friendly, providing a better onboarding experience for new users and contributors.