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 @@ ![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg) [![Metrics (examples)](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml/badge.svg)](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!
+ +
+ +### 🐙 Features + +* 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** * 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** and **organizations** accounts, and even **repositories**! -* Save your metrics as **images** (SVG, PNG or JPG), **markdown**, **PDF** or **JSON**! - * Upload them through commits, pull request and gists, or handle output manually -* Test it live on [metrics.lecoq.io](https://metrics.lecoq.io)! - * Get a quick overview of any user with [✨ metrics insights](https://metrics.lecoq.io/about) +* Support **users**, **organizations** and even **repositories** +* Transparent by default so it'll blend well whether light or dark mode is used +* Save your metrics as **images** (SVG, PNG or JPEG), **markdown**, **PDF** or **JSON** + * Upload them to GitHub through commits, pull requests and gists, or handle renders yourself +* Works either as [GitHub action](https://github.com/marketplace/actions/metrics-embed) or as [web instance](https://metrics.lecoq.io) + diff --git a/.github/readme/partials/shared.md b/.github/readme/partials/shared.md deleted file mode 100644 index 42cad6bb..00000000 --- a/.github/readme/partials/shared.md +++ /dev/null @@ -1,25 +0,0 @@ -## 🦑 Interested to get your own? - -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!
- -
- diff --git a/tests/ci.test.js b/tests/ci.test.js index 22208f31..b7c79584 100644 --- a/tests/ci.test.js +++ b/tests/ci.test.js @@ -22,7 +22,7 @@ describe("Check files editions (checkout your files if needed)", () => { ".github/PULL_REQUEST_TEMPLATE/*", ".github/readme/partials/license.md", ".github/readme/partials/setup.md", - ".github/readme/partials/shared.md", + ".github/readme/partials/features.md", ".github/readme/partials/documentation/compatibility.md", ".github/readme/partials/introduction.md", ".github/workflows/*",