Improve README and security policy - #63
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR modernizes the repository’s documentation by updating the README’s usage guidance and replacing the placeholder security policy with a project-specific SECURITY.md aligned with GitHub’s private reporting flow.
Changes:
- Refresh README installation, CLI usage, library examples, and protocol/limitations explanations (including RFC references and server requirements).
- Replace outdated badges/links (GoDoc/Go Report Card) with pkg.go.dev Go Reference and GitHub Actions status.
- Introduce a concrete security policy covering supported versions, reporting, expectations, scope, and safe testing guidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| SECURITY.md | Replaces template text with a tailored security policy (supported versions, private reporting, scope, response expectations). |
| README.md | Updates badges and significantly expands/clarifies installation, CLI/library usage, NAT discovery limitations, and RFC references. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+148
to
+149
| This snippet requires the standard library's `errors` package. A non-nil | ||
| behavior result may contain partial results when a later probe fails. |
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
masterAPI from the older tagged release so installation guidance matches the documented features.Why
The existing README contains outdated tooling and installation guidance, conflates STUN with a complete UDP hole-punching solution, and does not fully explain server requirements. The existing security policy is GitHub's template text with unrelated example versions and no reporting channel.
Validation
go mod tidyandgo mod verifygo vet -mod=readonly ./...staticcheck -checks=all ./...git diff --check