Update features for README
This commit is contained in:
2
.github/readme/README.md
vendored
2
.github/readme/README.md
vendored
@@ -2,6 +2,6 @@
|
|||||||
|
|
||||||
 [](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml)
|
 [](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`) %>
|
<%- await include(`/partials/${partial}.md`) %>
|
||||||
<% } %>
|
<% } %>
|
||||||
|
|||||||
BIN
.github/readme/imgs/features_embed.gif
vendored
Normal file
BIN
.github/readme/imgs/features_embed.gif
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 437 KiB |
BIN
.github/readme/imgs/features_insights.gif
vendored
Normal file
BIN
.github/readme/imgs/features_insights.gif
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 363 KiB |
40
.github/readme/partials/features.md
vendored
40
.github/readme/partials/features.md
vendored
@@ -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:
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<th><a href="https://metrics.lecoq.io">📊 Metrics embed</a></th>
|
||||||
|
<th><a href="https://metrics.lecoq.io/about">✨ Metrics insights</a></th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">
|
||||||
|
Embed metrics images on your profile readme or blog!<br>
|
||||||
|
Use GitHub actions for even more features!<br>
|
||||||
|
<img src="/.github/readme/imgs/features_embed.gif" width="441">
|
||||||
|
</td>
|
||||||
|
<td align="center">
|
||||||
|
Share your metrics with friends and on social medias!<br>
|
||||||
|
No configuration needed!<br>
|
||||||
|
<img src="/.github/readme/imgs/features_insights.gif" width="441">
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
### 🐙 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
|
* 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**!
|
* Support **users**, **organizations** and even **repositories**
|
||||||
* Save your metrics as **images** (SVG, PNG or JPG), **markdown**, **PDF** or **JSON**!
|
* Transparent by default so it'll blend well whether light or dark mode is used
|
||||||
* Upload them through commits, pull request and gists, or handle output manually
|
* Save your metrics as **images** (SVG, PNG or JPEG), **markdown**, **PDF** or **JSON**
|
||||||
* Test it live on [metrics.lecoq.io](https://metrics.lecoq.io)!
|
* Upload them to GitHub through commits, pull requests and gists, or handle renders yourself
|
||||||
* Get a quick overview of any user with [✨ metrics insights](https://metrics.lecoq.io/about)
|
* Works either as [GitHub action](https://github.com/marketplace/actions/metrics-embed) or as [web instance](https://metrics.lecoq.io)
|
||||||
|
|
||||||
|
|||||||
25
.github/readme/partials/shared.md
vendored
25
.github/readme/partials/shared.md
vendored
@@ -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:
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th><a href="https://metrics.lecoq.io">📊 Metrics embed</a></th>
|
|
||||||
<th><a href="https://metrics.lecoq.io/about">✨ Metrics insights</a></th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="center">
|
|
||||||
Embed metrics images on your profile readme or blog!<br>
|
|
||||||
Use GitHub actions for even more features!<br>
|
|
||||||
<img width="441" height="1">
|
|
||||||
</td>
|
|
||||||
<td align="center">
|
|
||||||
Share your metrics with friends and on social medias!<br>
|
|
||||||
No configuration needed!<br>
|
|
||||||
<img width="441" height="1">
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@ describe("Check files editions (checkout your files if needed)", () => {
|
|||||||
".github/PULL_REQUEST_TEMPLATE/*",
|
".github/PULL_REQUEST_TEMPLATE/*",
|
||||||
".github/readme/partials/license.md",
|
".github/readme/partials/license.md",
|
||||||
".github/readme/partials/setup.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/documentation/compatibility.md",
|
||||||
".github/readme/partials/introduction.md",
|
".github/readme/partials/introduction.md",
|
||||||
".github/workflows/*",
|
".github/workflows/*",
|
||||||
|
|||||||
Reference in New Issue
Block a user