From f51b0f3f17cb85f485fe7b77befc31c33c862a56 Mon Sep 17 00:00:00 2001 From: Artem Lykhvar Date: Wed, 9 Jul 2025 01:30:51 +0300 Subject: [PATCH] docs: Add Homebrew instructions and CONTRIBUTORS file --- CONTRIBUTORS.md | 9 +++++++++ README.md | 25 +++++++++++++++++++++---- public/index.html | 45 +++++++++++++++++++++++++++++++++++---------- 3 files changed, 65 insertions(+), 14 deletions(-) create mode 100644 CONTRIBUTORS.md diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..9b0bd26 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,9 @@ +# Contributors + +A huge thank you to all the people who have contributed to vet! This project would not be the same without your help. + +## Core Contributions & Ideas + +* **[@smartwatermelon](https://github.com/smartwatermelon)** - Provided the initial concept and working formula for the Homebrew distribution, a key feature for macOS and Linux users. + +*(If you have contributed to the project, please feel free to open a pull request to add your name!)* diff --git a/README.md b/README.md index aa2a61c..72517e0 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,24 @@ vet https://example.com/install.sh ## Installation -We believe you should never blindly trust a script from the internet—not even ours. That's why `vet` exists. The installation process itself is a perfect demonstration of the problem vet solves. +We believe you should never blindly trust a script from the internet—not even ours. That's why `vet` exists. The installation process itself is a perfect demonstration of the problem `vet` solves. -### The Safe Way (Recommended) +## Homebrew (macOS/Linux) - Recommended -This is the two-step "Download, then Review" process that vet automates. +The easiest and recommended way to install `vet` is via Homebrew. +``` +# First, tap the official repository +brew tap vet-run/vet + +# Now, install the formula +brew install vet-run +``` +**Note:** The formula is named `vet-run` to avoid a conflict with another tool in the Homebrew ecosystem, but this command will correctly install the `vet` executable on your system. + +## Manual Installation + +### The Safe Way +If you don't use Homebrew, or if you simply wish to follow the security-first principle that `vet` champions, you can perform a manual installation. This is the two-step "Download, then Review" process that demonstrates exactly what `vet` automates for you. 1. **Download the installer**: @@ -65,7 +78,7 @@ bash install_vet.sh Congratulations! You just manually performed the process that vet will now automate for you. -### The "Trusting" One-Liner +### The "Trusting" One-Liner (The Anti-Pattern) ```bash # This is the curl-to-bash pattern. # Don't actually do this. That's the whole point. @@ -128,6 +141,10 @@ Contributions are welcome! If you have an idea for a new feature or have found a - Open a new Pull Request. +## Acknowledgements + +This project is made better by its contributors. See our [Contributors](CONTRIBUTORS.md) file to recognize those who have helped shape `vet`. + ## License This project is licensed under the MIT License - see the [LICENSE](https://spdx.org/licenses/MIT.html) file for details. diff --git a/public/index.html b/public/index.html index f91eab7..3ac03f0 100644 --- a/public/index.html +++ b/public/index.html @@ -20,7 +20,7 @@ .container { width: 100%; max-width: 780px; - padding: 2.5rem; + padding: 2.5rem 2.5rem 7rem 2.5rem; } h1 { color: #75b6ff; @@ -30,7 +30,7 @@ h2 { font-weight: normal; font-size: 1rem; - color: #e4e4e4; + color: #f1f1f1; margin-top: 0em; margin-bottom: 1em; font-weight: 600; @@ -38,6 +38,11 @@ h3 { margin-top: 2rem; font-size: 1.2rem; + color: #f1f1f1; + } + h3.section { + margin-top: 1.5rem; + font-size: 1rem; color: #e4e4e4; } h4 { @@ -82,6 +87,15 @@ color: #6a6a6a; font-style: italic; } + ol { + font-size: 0.9rem; + display: block; + list-style-type: decimal; + margin-block-start: 1em; + margin-block-end: 1em; + padding-inline-start: 40px; + unicode-bidi: isolate; + } .install-box { background-color: #161b22; padding: 0.6rem; @@ -104,9 +118,11 @@ a:hover { text-decoration: underline; } - .footer { + .note { margin-top: 2rem; - font-size: 0.9rem; + font-size: 0.85rem; + width: 100%; + text-align: right; } .ascii-header { color: #75b6ff; @@ -120,6 +136,9 @@
+
+ View the source on GitHub +

vet

Don't just run it — vet it.

Stop blindly piping to bash. vet lets you inspect remote scripts for changes, run them through a linter, and require your explicit approval before they can execute.

@@ -143,7 +162,17 @@

The Solution

vet https://example.com/install.sh

Installation

-

The Safe Way (Recommended)

+

Homebrew (macOS/Linux)

+

The easiest and recommended way to install vet is via Homebrew.

+
+
# First, tap the official repository
+brew tap vet-run/vet
+
+# Now, install the formula
+brew install vet-run
+
+

Manual Installation

+

The Safe Way

This is the two-step "Download, then Review" process that vet automates.

  1. @@ -172,16 +201,12 @@

    The Safe Way (Recommended)

Congratulations! You just manually performed the process that vet will now automate for you.

-

The "Trusting" One-Liner

+

The "Trusting" One-Liner (The Anti-Pattern)

In your terminal, run:

# Don't actually do this. That's the whole point.
 curl -sL https://getvet.sh/install.sh | sh
- -
- ➤ View the source on GitHub -