Add Ren'Py (#149)

[xdg-ninja.git] / README.md

diff --git a/README.md b/README.md
index 1365abd198c4da08c9a83086a0f56c3276e1a577..68fa299b55fb25ed6d25f34974e22e397bbb1901 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), ...)
@@ -26,7 +32,7 @@ This will run every test in the default configuration.
 
 ### Optional
 
-- [glow](https://repology.org/project/glow/packages) for rendering markdown in the terminal ([bat](https://repology.org/project/bat-cat/packages), [pygmentize](https://repology.org/project/pygments/versions) or [highlight](https://repology.org/project/highlight/packages) can be used as fallback, but glow's output is clearer and therefore glow is recommended)
+- [glow](https://repology.org/project/glow/packages) for rendering Markdown in the terminal ([bat](https://repology.org/project/bat-cat/packages), [pygmentize](https://repology.org/project/pygments/versions) or [highlight](https://repology.org/project/highlight/packages) can be used as fallback, but glow's output is clearer and therefore glow is recommended)
 
 ## Configuration
 
@@ -36,7 +42,7 @@ You define a program, and then a list of files and directories which this progra
 
 For each file/directory, you specify if it can be (re)moved.
 
-If this is the case, you also specify instructions on how to accomplish this in markdown.
+If this is the case, you also specify instructions on how to accomplish this in Markdown.
 
 Files in this directory can have any name, but using the name of the program is encouraged.
 
@@ -59,7 +65,7 @@ You can use `cabal build`, `stack build`, or the provided dockerfile in _build/_
 
 We're going to use _git_ as an example.
 
-It puts the file _.gitconfig_ into _$HOME.
+It puts the file _.gitconfig_ into _$HOME_.
 
 Luckily, the XDG spec is supported by git, so we can simply move the file to _XDG_CONFIG_HOME/git/config_.