]> glassweightruler.freedombox.rocks Git - xdg-ninja.git/blobdiff - README.md
Add more programs
[xdg-ninja.git] / README.md
index 9070615985ca8a636ed57329fe3e1774cdc8accc..a86b9c7a175e47d7b9602d63dc70cd0679250114 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,10 +15,16 @@ The configurations are from the [arch wiki page on XDG_BASE_DIR](https://wiki.ar
 
 ## Running
 
+### Cloning Manually
+
 Clone the repository somewhere, then run the _./xdg-ninja.sh_ script.
 
 This will run every test in the default configuration.
 
+### Installing with Homebrew
+
+To install xdg-ninja with [Homebrew](https://brew.sh), run `brew install xdg-ninja` to install the script and all of its dependencies, then run the `xdg-ninja` command.
+
 ## Dependencies
 
 - your favorite POSIX-compliant shell ([bash](https://repology.org/project/bash/packages), [zsh](https://repology.org/project/zsh/packages), [dash](https://repology.org/project/dash-shell/packages), ...)
@@ -102,4 +108,4 @@ Now, we can assemble our final json file:
 
 Saving this as _git.json_ in the _programs/_ directory will result in the script picking it up and checking the file.
 
-If you've created a configuration for a file that isn't in the offical repository yet, make sure to create a pull request so that other people can benefit from it as well.
+If you've created a configuration for a file that isn't in the official repository yet, make sure to create a pull request so that other people can benefit from it as well.