Improve README with environment variables, usage guide, screenshots, … #2085
Conversation
This file contains hidden or 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
…and contributor onboarding ## Summary This PR improves the README to make OpenSign more beginner-friendly and easier to understand. ## Changes Made - Added a clear **Environment Variables** section with explanations for common configuration values - Organized **application screenshots** with headings and brief descriptions for better context - Enhanced the **Usage** section with basic steps to help new users get started - Improved **Contribution Guidelines** by adding guidance for first-time contributors ## Why This Change - Helps new users understand setup and configuration more easily - Improves documentation clarity and readability - Encourages beginner open-source contributions - Reduces confusion for first-time self-hosters ## Type of Change - Documentation improvement (no functional or behavioral changes) ## Checklist - [x] Documentation changes only - [x] No breaking changes - [x] Beginner-friendly improvements
|
@Ashmitayadav004 is attempting to deploy a commit to the prafull 's projects Team on Vercel. A member of the Team first needs to authorize it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
…and contributor onboarding
Summary
This PR improves the README to make OpenSign more beginner-friendly and easier to understand.
Changes Made
Why This Change
Type of Change
Checklist