diff --git a/source/plugins/poopmap/README.md b/source/plugins/poopmap/README.md index 7eaca938..d95c506b 100644 --- a/source/plugins/poopmap/README.md +++ b/source/plugins/poopmap/README.md @@ -1,45 +1,29 @@ -### 💩 PoopMap plugin - -The *poopmap* plugin displays statistics from your [PoopMap](https://poopmap.net) account - + - + + + + + + + + + + + + + + + +
- - -

💩 PoopMap plugin

This plugin displays statistics from a PoopMap account.

+
Authors@matievisthekat
Supported features
→ Full specification
📗 Classic template
👤 Users
đŸ—ī¸ plugin_poopmap_token
+ + +
+ -
- đŸ’Ŧ Obtaining a PoopMap token - -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 - -
- -
- -Tap "Share Profile" in the top right - -
- -
- -Tap "Copy to Clipboard" the copy the link to your clipboard - -
- -
- -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. -
- -#### âžĄī¸ Available options +## âžĄī¸ Available options @@ -48,7 +32,7 @@ You now have your PoopMap token! This token will not expire and it can only acce - @@ -68,7 +52,7 @@ You now have your PoopMap token! This token will not expire and it can only acce - @@ -80,9 +64,34 @@ You now have your PoopMap token! This token will not expire and it can only acce
plugin_poopmap

Display PoopMap stats

+

Enable poopmap plugin

plugin_poopmap_days

PoopMap time range

+

Time range

-*[→ 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 + +
+ +
+ +Tap "Share Profile" in the top right + +
+ +
+ +Tap "Copy to Clipboard" + +
+ +
+ +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 ```yaml @@ -92,4 +101,4 @@ with: plugin_poopmap: 'yes' ``` - \ No newline at end of file + diff --git a/source/plugins/poopmap/metadata.yml b/source/plugins/poopmap/metadata.yml index e4038e59..9df3e8ed 100644 --- a/source/plugins/poopmap/metadata.yml +++ b/source/plugins/poopmap/metadata.yml @@ -1,5 +1,8 @@ name: "💩 PoopMap plugin" 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: - matievisthekat supports: @@ -7,25 +10,22 @@ supports: scopes: [] inputs: - # Enable or disable plugin plugin_poopmap: - description: Display PoopMap stats + description: Enable poopmap plugin type: boolean default: no - # PoopMap API token plugin_poopmap_token: description: PoopMap API token type: token default: "" - # Time range to use for displayed stats plugin_poopmap_days: - description: PoopMap time range + description: Time range type: number values: - - 7 # Last week - - 30 # Last month - - 180 # Last 6 months - - 365 # Last year + - 7 + - 30 + - 180 + - 365 default: 7