diff --git a/.github/readme/README.md b/.github/readme/README.md index 2df71f29..f961f641 100644 --- a/.github/readme/README.md +++ b/.github/readme/README.md @@ -2,6 +2,6 @@  [](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml) -<% for (const partial of ["introduction", "features", "shared", "setup", "documentation", "license", "references"]) { -%> +<% for (const partial of ["introduction", "features", "setup", "documentation", "license", "references"]) { -%> <%- await include(`/partials/${partial}.md`) %> <% } %> diff --git a/.github/readme/imgs/features_embed.gif b/.github/readme/imgs/features_embed.gif new file mode 100644 index 00000000..7647547e Binary files /dev/null and b/.github/readme/imgs/features_embed.gif differ diff --git a/.github/readme/imgs/features_insights.gif b/.github/readme/imgs/features_insights.gif new file mode 100644 index 00000000..a9a4169f Binary files /dev/null and b/.github/readme/imgs/features_insights.gif differ diff --git a/.github/readme/partials/features.md b/.github/readme/partials/features.md index b158b139..417d64aa 100644 --- a/.github/readme/partials/features.md +++ b/.github/readme/partials/features.md @@ -1,9 +1,35 @@ -## 🐙 Features +## 🦑 Interested to get your own? -* Create infographics from **<%= Object.entries(plugins).filter(([key, value]) => (value)&&(!["base", "core"].includes(key))).length %> plugins**, **<%= Object.entries(templates).filter(([key, value]) => (value)&&(!["community"].includes(key))).length %> templates** and **<%= Object.entries(descriptor.inputs).length %> options**! +For a fully-featured experience you should use **metrics** as a [GitHub Action](https://github.com/marketplace/actions/metrics-embed), but you can also try it now at [metrics.lecoq.io](https://metrics.lecoq.io/) with your GitHub username! + +Choose `📊 Metrics embed` if you want to customize your GitHub profile and `✨ Metrics insights` to get a quick overview of your GitHub statistics: + +
| 📊 Metrics embed | +✨ Metrics insights | +
|---|---|
|
+ Embed metrics images on your profile readme or blog! + Use GitHub actions for even more features! +
+ |
+
+ Share your metrics with friends and on social medias! + No configuration needed! +
+ |
+
| 📊 Metrics embed | -✨ Metrics insights | -
|---|---|
|
- Embed metrics images on your profile readme or blog! - Use GitHub actions for even more features! - |
-
- Share your metrics with friends and on social medias! - No configuration needed! - |
-