Rewrite README for public hardening#1
Closed
s00ly wants to merge 1 commit into
Closed
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
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.
What changed
IVPN_*prototype prefix.Why
The original README was credible but optimized for auditors rather than first-time contributors. It also used an internal prototype name, buried the contribution path, and overstated two controls. This rewrite aims to attract privacy and security reviewers through a memorable purpose, concrete work, and honest evidence rather than hype.
Verification
go run ./cmd/ivpn --checkwith a fresh generated key and temporary database.go test -count=1 ./...go vet ./...go mod verifygofmt -l cmd internalreturned no files.Maintainer decision still required
Select an OSI-approved license before describing the repository as open source or accepting code contributions. AGPL-3.0-or-later is the reciprocal freedom-tech option; Apache-2.0 is the adoption-first option.