doc(plugins/poopmap): update
This commit is contained in:
@@ -1,45 +1,29 @@
|
|||||||
### 💩 PoopMap plugin
|
<!--header-->
|
||||||
|
|
||||||
The *poopmap* plugin displays statistics from your [PoopMap](https://poopmap.net) account
|
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<td align="center">
|
<tr><th colspan="2"><h3>💩 PoopMap plugin</h3></th></tr>
|
||||||
<img src="https://github.com/matievisthekat/matievisthekat/blob/master/metrics.plugin.poopmap.svg">
|
<tr><td colspan="2" align="center"><p>This plugin displays statistics from a <a href="https://poopmap.net">PoopMap</a> account.</p>
|
||||||
<img width="900" height="1" alt="">
|
</td></tr>
|
||||||
</td>
|
<tr><th>Authors</th><td><a href="https://github.com/matievisthekat">@matievisthekat</a></td></tr>
|
||||||
|
<tr>
|
||||||
|
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
|
||||||
|
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>👤 Users</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>🗝️ plugin_poopmap_token</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2" align="center">
|
||||||
|
<img src="https://github.com/matievisthekat/matievisthekat/blob/master/metrics.plugin.poopmap.svg" alt=""></img>
|
||||||
|
<img width="900" height="1" alt="">
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
<!--/header-->
|
||||||
|
|
||||||
<details>
|
## ➡️ Available options
|
||||||
<summary>💬 Obtaining a PoopMap token</summary>
|
|
||||||
|
|
||||||
First, install the PoopMap app ([iOS](https://itunes.apple.com/us/app/poop-map/id1303269455?mt=8)/[Android](https://play.google.com/store/apps/details?id=net.poopmap)) and create an account.
|
|
||||||
|
|
||||||
Navigate to your profile in the app
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<img src="https://user-images.githubusercontent.com/45036977/143533812-c2776bcc-1fda-441e-bc96-cf21d4c69ca1.jpg" width="150" />
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Tap "Share Profile" in the top right
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<img src="https://user-images.githubusercontent.com/45036977/143533849-b7e03b4d-2903-4339-bbb7-e1fc0ea9724e.jpg" width="150" />
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Tap "Copy to Clipboard" the copy the link to your clipboard
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<img src="https://user-images.githubusercontent.com/45036977/143533856-f4a9fc0d-7bde-48c2-b579-e8ee91804d78.jpg" width="150" />
|
|
||||||
</div>
|
|
||||||
|
|
||||||
You should have something like `Haha, check out the places I've pooped on Poop Map https://api.poopmap.net/map?token=xxxxxxxxxx` copied.
|
|
||||||
|
|
||||||
Extract the `token` query paramater from the link
|
|
||||||
|
|
||||||
You now have your PoopMap token! This token will not expire and it can only access public details.
|
|
||||||
</details>
|
|
||||||
|
|
||||||
#### ➡️ Available options
|
|
||||||
|
|
||||||
<!--options-->
|
<!--options-->
|
||||||
<table>
|
<table>
|
||||||
@@ -48,7 +32,7 @@ You now have your PoopMap token! This token will not expire and it can only acce
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_poopmap</code></td>
|
<td nowrap="nowrap"><code>plugin_poopmap</code></td>
|
||||||
<td rowspan="2"><p>Display PoopMap stats</p>
|
<td rowspan="2"><p>Enable poopmap plugin</p>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -68,7 +52,7 @@ You now have your PoopMap token! This token will not expire and it can only acce
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_poopmap_days</code></td>
|
<td nowrap="nowrap"><code>plugin_poopmap_days</code></td>
|
||||||
<td rowspan="2"><p>PoopMap time range</p>
|
<td rowspan="2"><p>Time range</p>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -80,9 +64,34 @@ You now have your PoopMap token! This token will not expire and it can only acce
|
|||||||
</table>
|
</table>
|
||||||
<!--/options-->
|
<!--/options-->
|
||||||
|
|
||||||
*[→ Full specification](metadata.yml)*
|
## 🗝️ Obtaining a PoopMap token
|
||||||
|
|
||||||
#### ℹ️ Examples workflows
|
Install PoopMap app ([iOS](https://itunes.apple.com/us/app/poop-map/id1303269455?mt=8)/[Android](https://play.google.com/store/apps/details?id=net.poopmap)) and create an account.
|
||||||
|
|
||||||
|
Navigate to your profile in the app
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="https://user-images.githubusercontent.com/45036977/143533812-c2776bcc-1fda-441e-bc96-cf21d4c69ca1.jpg" width="150" />
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Tap "Share Profile" in the top right
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="https://user-images.githubusercontent.com/45036977/143533849-b7e03b4d-2903-4339-bbb7-e1fc0ea9724e.jpg" width="150" />
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Tap "Copy to Clipboard"
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="https://user-images.githubusercontent.com/45036977/143533856-f4a9fc0d-7bde-48c2-b579-e8ee91804d78.jpg" width="150" />
|
||||||
|
</div>
|
||||||
|
|
||||||
|
It should result in something like `Haha, check out the places I've pooped on Poop Map https://api.poopmap.net/map?token=xxxxxxxxxx` copied.
|
||||||
|
|
||||||
|
Extract the `token` query paramater from the link and use it in `plugin_poopmap_token`.
|
||||||
|
This token will not expire and it will be able to access only public details.
|
||||||
|
|
||||||
|
## ℹ️ Examples workflows
|
||||||
|
|
||||||
<!--examples-->
|
<!--examples-->
|
||||||
```yaml
|
```yaml
|
||||||
@@ -92,4 +101,4 @@ with:
|
|||||||
plugin_poopmap: 'yes'
|
plugin_poopmap: 'yes'
|
||||||
|
|
||||||
```
|
```
|
||||||
<!--/examples-->
|
<!--/examples-->
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
name: "💩 PoopMap plugin"
|
name: "💩 PoopMap plugin"
|
||||||
category: community
|
category: community
|
||||||
|
description: This plugin displays statistics from a [PoopMap](https://poopmap.net) account.
|
||||||
|
examples:
|
||||||
|
default: https://github.com/matievisthekat/matievisthekat/blob/master/metrics.plugin.poopmap.svg
|
||||||
authors:
|
authors:
|
||||||
- matievisthekat
|
- matievisthekat
|
||||||
supports:
|
supports:
|
||||||
@@ -7,25 +10,22 @@ supports:
|
|||||||
scopes: []
|
scopes: []
|
||||||
inputs:
|
inputs:
|
||||||
|
|
||||||
# Enable or disable plugin
|
|
||||||
plugin_poopmap:
|
plugin_poopmap:
|
||||||
description: Display PoopMap stats
|
description: Enable poopmap plugin
|
||||||
type: boolean
|
type: boolean
|
||||||
default: no
|
default: no
|
||||||
|
|
||||||
# PoopMap API token
|
|
||||||
plugin_poopmap_token:
|
plugin_poopmap_token:
|
||||||
description: PoopMap API token
|
description: PoopMap API token
|
||||||
type: token
|
type: token
|
||||||
default: ""
|
default: ""
|
||||||
|
|
||||||
# Time range to use for displayed stats
|
|
||||||
plugin_poopmap_days:
|
plugin_poopmap_days:
|
||||||
description: PoopMap time range
|
description: Time range
|
||||||
type: number
|
type: number
|
||||||
values:
|
values:
|
||||||
- 7 # Last week
|
- 7
|
||||||
- 30 # Last month
|
- 30
|
||||||
- 180 # Last 6 months
|
- 180
|
||||||
- 365 # Last year
|
- 365
|
||||||
default: 7
|
default: 7
|
||||||
|
|||||||
Reference in New Issue
Block a user