docs(tip): document status badge feature (#656)

ubclaunchpad · Mar 19, 2020 · f684e41 · f684e41
1 parent 55aa5d9
commit f684e41
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/docs/tip/cli/README.md b/docs/tip/cli/README.md
@@ -8,4 +8,4 @@ For a more general usage guide, refer to the [Inertia Usage Guide](https://inert
 For documentation regarding the daemon API, refer to the [API Reference](https://inertia.ubclaunchpad.com/api).
 
 * Generated: 2020-Mar-19
-* Version: v0.6.0-preview2-24-g44442aa
+* Version: v0.6.0-preview2-23-g55aa5d9
diff --git a/docs/tip/cli/inertia_remote_upgrade.md b/docs/tip/cli/inertia_remote_upgrade.md
@@ -21,7 +21,7 @@ inertia remote upgrade dev staging
 ```
       --all              upgrade all remotes
   -h, --help             help for upgrade
-      --version string   specify Inertia daemon version to set (default "v0.6.0-preview2-24-g44442aa")
+      --version string   specify Inertia daemon version to set (default "v0.6.0-preview2-23-g55aa5d9")
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/tip/index.html b/docs/tip/index.html
@@ -1090,6 +1090,11 @@ <h2 id='swag'>Swag</h2><pre class="highlight markdown tab-markdown"><code><span
 <p>Add a cool Inertia badge to your README if you use Inertia!</p>
 
 <p><a href="https://github.com/ubclaunchpad/inertia"><img src="https://img.shields.io/badge/deploying%20with-inertia-blue.svg" alt="Deployed with Inertia" /></a></p>
+<pre class="highlight markdown tab-markdown"><code><span class="p">![</span><span class="nv">inertia status</span><span class="p">](</span><span class="sx">https://img.shields.io/endpoint?url=https://INERTIA_ADDRESS:4303/status?badge=true</span><span class="p">)</span>
+</code></pre>
+<p>A live status badge is also available - just replace <code>INERTIA_ADDRESS</code> in the example with the
+address of your Inertia daemon and you&#39;ll be able to check on the status of your project using
+the badge!</p>
 <h1 id='contributing'>Contributing</h1>
 <p>Any contribution (pull requests, feedback, bug reports, ideas, etc.) is welcome!</p>
 

diff --git a/docs_src/index.html.md b/docs_src/index.html.md
@@ -822,6 +822,14 @@ Add a cool Inertia badge to your README if you use Inertia!
 
 [![Deployed with Inertia](https://img.shields.io/badge/deploying%20with-inertia-blue.svg)](https://github.com/ubclaunchpad/inertia)
 
+```markdown
+![inertia status](https://img.shields.io/endpoint?url=https://INERTIA_ADDRESS:4303/status?badge=true)
+```
+
+A live status badge is also available - just replace `INERTIA_ADDRESS` in the example with the
+address of your Inertia daemon and you'll be able to check on the status of your project using
+the badge!
+
 # Contributing
 
 Any contribution (pull requests, feedback, bug reports, ideas, etc.) is welcome!