Skip to content

Commit

Permalink
Update docs verbiage for new functionality.
Browse files Browse the repository at this point in the history
  • Loading branch information
arusahni committed Feb 4, 2020
1 parent 476e4c0 commit dc62e91
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
17 changes: 12 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h1 class="title">
</section>
<section class="section">
<div class="container content is-desktop">
<h2 class="subtitle">Check out branches by their pull (or merge) request ID</h2>
<h2 class="subtitle is-uppercase">Check out branches by their pull (or merge) request ID</h2>
<p>Don't waste time doing this:
<ul>
<li>Switching to a browser</li>
Expand All @@ -48,12 +48,12 @@ <h2 class="subtitle">Check out branches by their pull (or merge) request ID</h2>
</ul>
</p>
<p>Instead, run <code>git req REQUEST_NUMBER</code> to check out the corresponding branch.</p>
<h2 class="subtitle">Supported services</h2>
<h2 class="subtitle is-uppercase">Supported services</h2>
<ul>
<li>GitHub</li>
<li>GitLab (both GitLab.com and self-hosted)</li>
</ul>
<h2 class="subtitle">Getting started</h2>
<h2 class="subtitle is-uppercase">Getting started</h2>
<ol>
<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>
<li>Decompress the archive.</li>
Expand All @@ -65,8 +65,15 @@ <h2 class="subtitle">Getting started</h2>
</li>
<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>
</ol>
<h2 class="subtitle">Questions? Issues?</h2>
If you have questions, ask on GitHub, or on <a href="https://twitter.com/IAmAru">Twitter</a>. Please file issues on the <a href="https://github.com/arusahni/git-req/issues">GitHub project</a>.
<h2 class="subtitle is-uppercase">Other features</h2>
<p>In addition to checking out requests by ID, <code>git-req</code> also supports:</p>
<ul>
<li>Viewing open requests with <code>git req --list</code></li>
<li>Targeting different remotes with <code>git req -u</code></li>
<li>Generating shell completions <code>git req --completions</code></li>
</ul>
<h2 class="subtitle is-uppercase">Questions? Issues?</h2>
<p>If you have questions, ask on GitHub, or on <a href="https://twitter.com/IAmAru">Twitter</a>. Please file issues on the <a href="https://github.com/arusahni/git-req/issues">GitHub project</a>.</p>
</div>
</section>
<footer class="footer">
Expand Down
5 changes: 0 additions & 5 deletions pkg/aur/PKGBUILD
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# This is an example PKGBUILD file. Use this as a start to creating your own,
# and remove these comments. For more information, see 'man PKGBUILD'.
# NOTE: Please fill out the license field for your package! If it is unknown,
# then please put 'unknown'.

# Maintainer: Aru Sahni <aru@arusahni.net>
pkgname=git-req
pkgver=2.0.1
Expand Down

0 comments on commit dc62e91

Please sign in to comment.