chore: README improvements

vvvvv · Nov 12, 2024 · 14ffc7e · 14ffc7e
1 parent 0727fd3
commit 14ffc7e
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 3 deletions.
diff --git a/Casks/wezterm-nightly.rb → Casks/[email protected] b/Casks/wezterm-nightly.rb → Casks/[email protected]
@@ -1,4 +1,4 @@
-cask "wezterm-nightly" do
+cask "wezterm@nightly" do
   version :latest
   sha256 :no_check
 

diff --git a/README.md b/README.md
@@ -1,6 +1,39 @@
 # homebrew-vvvvv
 
-```
+A collection of Homebrew **Formulas** and **Casks** that aren't officially supported but are essential for my workflow.
+
+## Formulas
+- **[email protected]**  Lua version 5.1
+- **openvpn**  OpenVPN version 2.6
+
+## Casks
+- **wezterm@nightly**  Nightly version of Wezterm (Now available in [homebrew-cask](https://github.com/Homebrew/homebrew-cask/blob/master/Casks/w/[email protected])!)
+- **zig@nightly**  Nightly version of Zig
+
+### Usage
+
+#### Tap the Repository
+
+Add this repository to Homebrew by running:
+
+```bash
 brew tap vvvvv/vvvvv [email protected]:vvvvv/homebrew-vvvvv.git
-brew install vvvvv/vvvvv/openvpn
 ```
+#### Install Formulas
+
+To install a formula, use:
+```bash
+brew install vvvvv/vvvvv/<formula>
+# e.g.
+brew install vvvvv/vvvvv/[email protected]
+```
+
+#### Install Casks
+
+To install a cask, use:
+```bash
+brew install --cask vvvvv/vvvvv/<cask>
+# e.g.
+brew install --cask vvvvv/vvvvv/zig@nightly
+```
+