Skip to content

Commit 657171a

Browse files
Auto-regenerate files
1 parent 0a20dab commit 657171a

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
Generate your metrics that you can embed everywhere, including your GitHub profile readme! It works for both user and organization accounts, and even for repositories!
66

7+
8+
<sup>*⚠️ This is the documentation of **v3.5-beta** (`@master` branch) which includes [unreleased features](https://github.com/lowlighter/metrics/compare/latest...master), see documentation of **v3.4** (`@latest` branch) [here](https://github.com/lowlighter/metrics/blob/latest/README.md).*</sup>
9+
10+
711
<table>
812
<tr>
913
<th align="center">For user accounts</th>
@@ -21,6 +25,9 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
2125
</tr>
2226
</table>
2327

28+
29+
And you can customize these heavily with plugins, templates and hundreds of options!
30+
2431
<table>
2532
<tr>
2633
<th colspan="2" align="center">
@@ -222,6 +229,9 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
222229
<tr>
223230
<td align="center">
224231
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.svg">
232+
<details><summary>With posts descriptions and cover images version</summary>
233+
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.full.svg">
234+
</details>
225235
<img width="900" height="1" alt="">
226236
</td>
227237
<td align="center">
@@ -236,6 +246,9 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
236246
<tr>
237247
<td align="center">
238248
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.tweets.svg">
249+
<details><summary>With tweets attachments version</summary>
250+
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.tweets.attachments.svg">
251+
</details>
239252
<img width="900" height="1" alt="">
240253
</td>
241254
<td align="center">
@@ -319,7 +332,7 @@ Assuming your username is `my-github-user`, you can then embed rendered metrics
319332
```
320333

321334
<details>
322-
<summary>💬 How to setup?</summary>
335+
<summary><b>💬 How to setup?</b> <i>(click to expand)</i></summary>
323336

324337
### 0. Setup your personal repository
325338

@@ -432,7 +445,7 @@ For convenience, you can use the shared instance available at [metrics.lecoq.io]
432445
This is mostly intended for previews, to enjoy all features consider using GitHub Action instead.
433446

434447
<details>
435-
<summary>💬 Fair use</summary>
448+
<summary><b>💬 Fair use</b> <i>(click to expand)</i></summary>
436449

437450
To ensure service availability, shared instance has a few limitations:
438451
* Images are cached for 15 minutes
@@ -458,7 +471,7 @@ Assuming your username is `my-github-user`, you can then embed rendered metrics
458471
```
459472

460473
<details>
461-
<summary>💬 How to setup?</summary>
474+
<summary><b>💬 How to setup?</b> <i>(click to expand)</i></summary>
462475

463476
### 0. Prepare your server
464477

@@ -750,7 +763,7 @@ While metrics targets mainly user accounts, it's possible to render metrics for
750763
![Metrics (organization account)](https://github.com/lowlighter/lowlighter/blob/master/metrics.organization.svg)
751764

752765
<details>
753-
<summary>💬 Metrics for organizations</summary>
766+
<summary><b>💬 Metrics for organizations</b> <i>(click to expand)</i></summary>
754767

755768
Setup is the same as for user accounts, though you'll need to add `read:org` scope, **whether you're member of target organization or not**.
756769

@@ -778,7 +791,7 @@ To support private repositories, add full `repo` scope to your personal token.
778791
</details>
779792

780793
<details>
781-
<summary>💬 Organizations memberships for user accounts</summary>
794+
<summary><b>💬 Organizations memberships for user accounts</b> <i>(click to expand)</i></summary>
782795

783796
Only public memberships can be displayed by metrics by default.
784797
You can manage your membership visibility in the `People` tab of your organization:
@@ -814,6 +827,8 @@ Copyright (c) 2020 lowlighter
814827
815828
![License details](https://github.com/lowlighter/lowlighter/blob/master/metrics.licenses.svg)
816829
830+
![Sponsors](https://github.com/lowlighter/lowlighter/blob/master/metrics.sponsors.svg)
831+
817832
## 📖 Useful references
818833
819834
* [GitHub GraphQL API](https://docs.github.com/en/graphql)

0 commit comments

Comments
 (0)