Skip to content

Commit f684e41

Browse files
authored
docs(tip): document status badge feature (#656)
1 parent 55aa5d9 commit f684e41

File tree

4 files changed

+15
-2
lines changed

4 files changed

+15
-2
lines changed

docs/tip/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ For a more general usage guide, refer to the [Inertia Usage Guide](https://inert
88
For documentation regarding the daemon API, refer to the [API Reference](https://inertia.ubclaunchpad.com/api).
99

1010
* Generated: 2020-Mar-19
11-
* Version: v0.6.0-preview2-24-g44442aa
11+
* Version: v0.6.0-preview2-23-g55aa5d9

docs/tip/cli/inertia_remote_upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ inertia remote upgrade dev staging
2121
```
2222
--all upgrade all remotes
2323
-h, --help help for upgrade
24-
--version string specify Inertia daemon version to set (default "v0.6.0-preview2-24-g44442aa")
24+
--version string specify Inertia daemon version to set (default "v0.6.0-preview2-23-g55aa5d9")
2525
```
2626

2727
### Options inherited from parent commands

docs/tip/index.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1090,6 +1090,11 @@ <h2 id='swag'>Swag</h2><pre class="highlight markdown tab-markdown"><code><span
10901090
<p>Add a cool Inertia badge to your README if you use Inertia!</p>
10911091

10921092
<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>
1093+
<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>
1094+
</code></pre>
1095+
<p>A live status badge is also available - just replace <code>INERTIA_ADDRESS</code> in the example with the
1096+
address of your Inertia daemon and you&#39;ll be able to check on the status of your project using
1097+
the badge!</p>
10931098
<h1 id='contributing'>Contributing</h1>
10941099
<p>Any contribution (pull requests, feedback, bug reports, ideas, etc.) is welcome!</p>
10951100

docs_src/index.html.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -822,6 +822,14 @@ Add a cool Inertia badge to your README if you use Inertia!
822822

823823
[![Deployed with Inertia](https://img.shields.io/badge/deploying%20with-inertia-blue.svg)](https://github.com/ubclaunchpad/inertia)
824824

825+
```markdown
826+
![inertia status](https://img.shields.io/endpoint?url=https://INERTIA_ADDRESS:4303/status?badge=true)
827+
```
828+
829+
A live status badge is also available - just replace `INERTIA_ADDRESS` in the example with the
830+
address of your Inertia daemon and you'll be able to check on the status of your project using
831+
the badge!
832+
825833
# Contributing
826834

827835
Any contribution (pull requests, feedback, bug reports, ideas, etc.) is welcome!

0 commit comments

Comments
 (0)