Repository navigation
Add a README - #65
Merged
Merged
Add a README#65
Conversation
ian-at-strix
force-pushed
the
docs/concise-readme
branch
from
October 23, 2026 16:33
9e2a418 to
037cf67
Compare
ian-at-strix
force-pushed
the
docs/concise-readme
branch
from
October 23, 2026 16:52
037cf67 to
733e751
Compare
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: A short README: on-device screening, supported registries, features, platforms, install and config paths.
Why: The repo had no README; it should say what the firewall does, that it's a Strix product, and how to install it.
How: One
README.md, 72 lines. Homebrew is gone (#87); install is the cargo-dist shell/PowerShell installers,cargo install,Firewall.pkgor the MSI.Tested: Artifact names match
dist planon main (strix-firewall-installer.sh/.ps1, the MSI); config paths matchconfig::pathand the macOS/Windows constants.Untested: The
releases/latestlinks resolve only after a non-prerelease release;Firewall.pkgships from #85 but hasn't been released yet.