Skip to content

Commit 4ae1831

Browse files
committed
Update features for README
1 parent 67d5b66 commit 4ae1831

File tree

6 files changed

+35
-34
lines changed

6 files changed

+35
-34
lines changed

.github/readme/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
![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)
44

5-
<% for (const partial of ["introduction", "features", "shared", "setup", "documentation", "license", "references"]) { -%>
5+
<% for (const partial of ["introduction", "features", "setup", "documentation", "license", "references"]) { -%>
66
<%- await include(`/partials/${partial}.md`) %>
77
<% } %>
437 KB
Loading
363 KB
Loading
Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,35 @@
1-
## 🐙 Features
1+
## 🦑 Interested to get your own?
22

3-
* 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**!
3+
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!
4+
5+
Choose `📊 Metrics embed` if you want to customize your GitHub profile and `✨ Metrics insights` to get a quick overview of your GitHub statistics:
6+
7+
<table>
8+
<tr>
9+
<th><a href="https://metrics.lecoq.io">📊 Metrics embed</a></th>
10+
<th><a href="https://metrics.lecoq.io/about">✨ Metrics insights</a></th>
11+
</tr>
12+
<tr>
13+
<td align="center">
14+
Embed metrics images on your profile readme or blog!<br>
15+
Use GitHub actions for even more features!<br>
16+
<img src="/.github/readme/imgs/features_embed.gif" width="441">
17+
</td>
18+
<td align="center">
19+
Share your metrics with friends and on social medias!<br>
20+
No configuration needed!<br>
21+
<img src="/.github/readme/imgs/features_insights.gif" width="441">
22+
</td>
23+
</tr>
24+
</table>
25+
26+
### 🐙 Features
27+
28+
* 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**
429
* 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
5-
* Support **users** and **organizations** accounts, and even **repositories**!
6-
* Save your metrics as **images** (SVG, PNG or JPG), **markdown**, **PDF** or **JSON**!
7-
* Upload them through commits, pull request and gists, or handle output manually
8-
* Test it live on [metrics.lecoq.io](https://metrics.lecoq.io)!
9-
* Get a quick overview of any user with [✨ metrics insights](https://metrics.lecoq.io/about)
30+
* Support **users**, **organizations** and even **repositories**
31+
* Transparent by default so it'll blend well whether light or dark mode is used
32+
* Save your metrics as **images** (SVG, PNG or JPEG), **markdown**, **PDF** or **JSON**
33+
* Upload them to GitHub through commits, pull requests and gists, or handle renders yourself
34+
* Works either as [GitHub action](https://github.com/marketplace/actions/metrics-embed) or as [web instance](https://metrics.lecoq.io)
35+

.github/readme/partials/shared.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

tests/ci.test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ describe("Check files editions (checkout your files if needed)", () => {
2222
".github/PULL_REQUEST_TEMPLATE/*",
2323
".github/readme/partials/license.md",
2424
".github/readme/partials/setup.md",
25-
".github/readme/partials/shared.md",
25+
".github/readme/partials/features.md",
2626
".github/readme/partials/documentation/compatibility.md",
2727
".github/readme/partials/introduction.md",
2828
".github/workflows/*",

0 commit comments

Comments
 (0)