From 657171a3794ad2f197b9f25ce320cf60dbe36637 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 2 Mar 2021 10:34:53 +0000 Subject: [PATCH] Auto-regenerate files --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 16e90a9b..1fd1cf70 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ 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! + +*⚠️ 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).* + + @@ -21,6 +25,9 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
For user accounts
+ +And you can customize these heavily with plugins, templates and hundreds of options! +
@@ -222,6 +229,9 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
+
With posts descriptions and cover images version + +
@@ -236,6 +246,9 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
+
With tweets attachments version + +
@@ -319,7 +332,7 @@ Assuming your username is `my-github-user`, you can then embed rendered metrics ```
-💬 How to setup? +💬 How to setup? (click to expand) ### 0. Setup your personal repository @@ -432,7 +445,7 @@ For convenience, you can use the shared instance available at [metrics.lecoq.io] This is mostly intended for previews, to enjoy all features consider using GitHub Action instead.
-💬 Fair use +💬 Fair use (click to expand) To ensure service availability, shared instance has a few limitations: * Images are cached for 15 minutes @@ -458,7 +471,7 @@ Assuming your username is `my-github-user`, you can then embed rendered metrics ```
-💬 How to setup? +💬 How to setup? (click to expand) ### 0. Prepare your server @@ -750,7 +763,7 @@ While metrics targets mainly user accounts, it's possible to render metrics for ![Metrics (organization account)](https://github.com/lowlighter/lowlighter/blob/master/metrics.organization.svg)
-💬 Metrics for organizations +💬 Metrics for organizations (click to expand) 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**. @@ -778,7 +791,7 @@ To support private repositories, add full `repo` scope to your personal token.
-💬 Organizations memberships for user accounts +💬 Organizations memberships for user accounts (click to expand) Only public memberships can be displayed by metrics by default. You can manage your membership visibility in the `People` tab of your organization: @@ -814,6 +827,8 @@ Copyright (c) 2020 lowlighter ![License details](https://github.com/lowlighter/lowlighter/blob/master/metrics.licenses.svg) +![Sponsors](https://github.com/lowlighter/lowlighter/blob/master/metrics.sponsors.svg) + ## 📖 Useful references * [GitHub GraphQL API](https://docs.github.com/en/graphql)