Skip to content

Commit e6c7d31

Browse files
committed
Doc improvements.
1 parent 9279335 commit e6c7d31

1 file changed

Lines changed: 24 additions & 5 deletions

File tree

docs/index.html

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,31 @@ <h2 class="subtitle is-uppercase">Supported services</h2>
5858
</ul>
5959
<h2 class="subtitle is-uppercase">Getting started</h2>
6060
<ol>
61-
<li><a href="https://github.com/arusahni/git-req/releases/latest">Download the binary for your operating system from the release page.</a> At this time, only Linux and macOS are officially supported. Builds for other platforms are available, but untested.</li>
62-
<li>Decompress the archive.</li>
63-
<li>Place the <code>git-req</code> binary somewhere in your <code>$PATH</code>.
61+
<li>Install git-req
6462
<ul>
65-
<li>Linux: suggested location <code>/usr/local/bin/</code></li>
66-
<li>macOS: suggested location <code>/usr/local/bin/</code>. This may not exist, so it'll need to be created with <code>mkdir -p /usr/local/bin</code>.</li>
63+
<li>MacOS Homebrew
64+
<ol>
65+
<li><code>brew tap arusahni/git-req</code></li>
66+
<li><code>brew install git-req</code></li>
67+
</ol>
68+
</li>
69+
<li>Arch Linux AUR
70+
<ol>
71+
<li><code>yay -Sy git-req</code></li>
72+
</ol>
73+
</li>
74+
<li>Everyone else...
75+
<ol>
76+
<li><a href="https://github.com/arusahni/git-req/releases/latest">Download the binary for your operating system from the release page.</a> At this time, only Linux and macOS are officially supported. Builds for other platforms are available, but untested.</li>
77+
<li>Decompress the archive.</li>
78+
<li>Place the <code>git-req</code> executable somewhere in your <code>$PATH</code>.
79+
<ul>
80+
<li>Linux: suggested location <code>/usr/local/bin/</code></li>
81+
<li>macOS: suggested location <code>/usr/local/bin/</code>. This may not exist, so it'll need to be created with <code>mkdir -p /usr/local/bin</code>.</li>
82+
</ul>
83+
</li>
84+
</ol>
85+
</li>
6786
</ul>
6887
</li>
6988
<li>That's it! The first time you run <code>git req REQUEST_NUMBER</code>, it will prompt you for your API credentials if necessary.</li>

0 commit comments

Comments
 (0)