diff --git a/README.md b/README.md index f6fa751c..8a166a42 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ And you can customize these heavily with plugins, templates and hundreds of opti @@ -371,20 +371,6 @@ And you can customize these heavily with plugins, templates and hundreds of opti - - - - - - - - - @@ -832,7 +817,6 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 - @@ -871,7 +855,6 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 - @@ -910,7 +893,6 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 - @@ -949,10 +931,9 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 - - + @@ -991,7 +972,6 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 - @@ -1030,7 +1010,6 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 - @@ -1069,7 +1048,6 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 - @@ -1108,7 +1086,6 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 -
- 🧩 36 plugins + 🧩 34+ plugins
📸 Website screenshot💉 Nightscout
- - - - - -
More to come soon! @@ -463,7 +449,7 @@ Choose `📊 Metrics embed` if you want to customize your GitHub profile and ` ### 🐙 Features -* Create infographics from **36 plugins**, **4 templates** and **219 options** +* Create infographics from **37 plugins**, **4 templates** and **219 options** * Even more **customization** with [community templates](source/templates/community) or by [forking this repository](https://github.com/lowlighter/metrics/network/members) and editing HTML/CSS/EJS * Support **users**, **organizations** and even **repositories** * Transparent by default so it'll blend well whether light or dark mode is used @@ -793,7 +779,6 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 🗼 ⏰ 💹📸
📗 Classic template✔️ ✔️ ✔️✔️
📘 Repository template✔️ ❌ ✔️✔️
📙 Terminal template❌ ❌ ❌✔️
📒 Markdown template✔️ ✓ ✓✓
Mode/Plugin🗼 ⏰ 💹📸
👤 User✔️ ✔️ ✔️✔️
👥 Organization✔️ ❌ ✔️✔️
📓 Repository✔️ ❌ ✔️✔️
@@ -1127,8 +1104,9 @@ See their respective documentation for more informations about how to setup them ## 🧩 Plugins Plugins are features which provide additional content and lets you customize your rendered metrics. +See their respective documentation for more informations about how to setup them. -See their respective documentation for more informations about how to setup them: +The following plugins are maintained by Metric's core team: * **Core** * [🗃️ Base content](/source/plugins/base/README.md) @@ -1166,13 +1144,16 @@ See their respective documentation for more informations about how to setup them * [✒️ Recent posts](/source/plugins/posts/README.md) * [🗼 Rss feed](/source/plugins/rss/README.md) * [🗨️ Stackoverflow plugin](/source/plugins/stackoverflow/README.md) + * [💹 Stock prices](/source/plugins/stock/README.md) * [🐤 Latest tweets](/source/plugins/tweets/README.md) * [⏰ WakaTime plugin](/source/plugins/wakatime/README.md) -* **Other** - * [📸 Website screenshot](/source/plugins/screenshot/README.md) - * [💹 Stock prices](/source/plugins/stock/README.md) -* **Community** *(provided and maintained by contributors)* + +### 🎲 Community plugins + +The following plugins are provided and maintained by Metrics's user community: * [💉 Nightscout](/source/plugins/nightscout/README.md) [@legoandmars](https://github.com/legoandmars) + * [💩 PoopMap plugin](/source/plugins/poopmap/README.md) [@matievisthekat](https://github.com/matievisthekat) + * [📸 Website screenshot](/source/plugins/screenshot/README.md) [@lowlighter](https://github.com/lowlighter) ### 🏦 Organizations metrics diff --git a/action.yml b/action.yml index fbb99fb3..4470e760 100644 --- a/action.yml +++ b/action.yml @@ -1275,34 +1275,6 @@ inputs: description: Time intervals between records default: 5m - # ==================================================================================== - # 📸 Website screenshot - - # Enable or disable plugin - plugin_screenshot: - description: Display a screenshot of any website - default: no - - # Screenshot title caption - plugin_screenshot_title: - description: Screenshot title caption - default: Screenshot - - # Website to take screenshot - plugin_screenshot_url: - description: Website to take screenshot - default: "" - - # Selector to take in screenshot - plugin_screenshot_selector: - description: Selector to take in screenshot - default: body - - # Display or remove default page background - plugin_screenshot_background: - description: Display or remove default page background - default: yes - # ==================================================================================== # 💉 Nightscout @@ -1341,6 +1313,52 @@ inputs: description: When the blood sugar is considered urgently high default: 250 + # ==================================================================================== + # 💩 PoopMap plugin + + # Enable or disable plugin + plugin_poopmap: + description: Display PoopMap stats + default: no + + # PoopMap API token + plugin_poopmap_token: + description: PoopMap API token + default: "" + + # Time range to use for displayed stats + plugin_poopmap_days: + description: PoopMap time range + default: 7 + + # ==================================================================================== + # 📸 Website screenshot + + # Enable or disable plugin + plugin_screenshot: + description: Display a screenshot of any website + default: no + + # Screenshot title caption + plugin_screenshot_title: + description: Screenshot title caption + default: Screenshot + + # Website to take screenshot + plugin_screenshot_url: + description: Website to take screenshot + default: "" + + # Selector to take in screenshot + plugin_screenshot_selector: + description: Selector to take in screenshot + default: body + + # Display or remove default page background + plugin_screenshot_background: + description: Display or remove default page background + default: yes + # ==================================================================================== # Action metadata diff --git a/settings.example.json b/settings.example.json index f44c748b..0dcd5f43 100644 --- a/settings.example.json +++ b/settings.example.json @@ -139,12 +139,16 @@ "token": null, "//":"Yahoo Finance token", "enabled": false, "//": "Display stock prices of a given company" }, - "screenshot":{ - "enabled": false, "//": "Display a screenshot of any website" - }, "nightscout":{ "enabled": false, "//": "Displays Blood Glucose" }, + "poopmap":{ + "token": null, "//":"PoopMap API token", + "enabled": false, "//": "Display PoopMap stats" + }, + "screenshot":{ + "enabled": false, "//": "Display a screenshot of any website" + }, "//": "" } } \ No newline at end of file diff --git a/source/plugins/README.md b/source/plugins/README.md index 74e599d0..60f91911 100644 --- a/source/plugins/README.md +++ b/source/plugins/README.md @@ -1,8 +1,9 @@ ## 🧩 Plugins Plugins are features which provide additional content and lets you customize your rendered metrics. +See their respective documentation for more informations about how to setup them. -See their respective documentation for more informations about how to setup them: +The following plugins are maintained by Metric's core team: * **Core** * [🗃️ Base content](/source/plugins/base/README.md) @@ -40,10 +41,13 @@ See their respective documentation for more informations about how to setup them * [✒️ Recent posts](/source/plugins/posts/README.md) * [🗼 Rss feed](/source/plugins/rss/README.md) * [🗨️ Stackoverflow plugin](/source/plugins/stackoverflow/README.md) + * [💹 Stock prices](/source/plugins/stock/README.md) * [🐤 Latest tweets](/source/plugins/tweets/README.md) * [⏰ WakaTime plugin](/source/plugins/wakatime/README.md) -* **Other** - * [📸 Website screenshot](/source/plugins/screenshot/README.md) - * [💹 Stock prices](/source/plugins/stock/README.md) -* **Community** *(provided and maintained by contributors)* + +### 🎲 Community plugins + +The following plugins are provided and maintained by Metrics's user community: * [💉 Nightscout](/source/plugins/nightscout/README.md) [@legoandmars](https://github.com/legoandmars) + * [💩 PoopMap plugin](/source/plugins/poopmap/README.md) [@matievisthekat](https://github.com/matievisthekat) + * [📸 Website screenshot](/source/plugins/screenshot/README.md) [@lowlighter](https://github.com/lowlighter)