docs: Document missing environment variables in README#1
Open
Conversation
echobt
added a commit
that referenced
this pull request
Jan 19, 2026
Remove P2P, new platform / challenge SDK
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
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.
Summary
This PR adds documentation for environment variables that were implemented in the codebase but were missing from the README.
Problem
The README documented only 4 environment variables (VGREP_HOST, VGREP_PORT, VGREP_MAX_RESULTS, VGREP_CONTENT) while the source code in src/config.rs actually supports additional environment variables for configuration overrides. Users had no way of knowing about these options without reading the source code.
Solution
Updated the Environment Variables section in the README to include all supported environment variables:
The section has also been reformatted as a table for better readability and consistency with other sections of the documentation, along with practical usage examples.
Testing
Verified that all documented environment variables match the implementation in src/config.rs and src/cli/commands.rs.
Related Issue
Fixes PlatformNetwork/bounty-challenge#35