Update documentation
This commit is contained in:
@@ -5,7 +5,7 @@ While metrics targets mainly user accounts, it's possible to render metrics for
|
||||

|
||||
|
||||
<details>
|
||||
<summary>💬 Metrics for organizations</summary>
|
||||
<summary><b>💬 Metrics for organizations</b> <i>(click to expand)</i></summary>
|
||||
|
||||
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**.
|
||||
|
||||
@@ -33,7 +33,7 @@ To support private repositories, add full `repo` scope to your personal token.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>💬 Organizations memberships for user accounts</summary>
|
||||
<summary><b>💬 Organizations memberships for user accounts</b> <i>(click to expand)</i></summary>
|
||||
|
||||
Only public memberships can be displayed by metrics by default.
|
||||
You can manage your membership visibility in the `People` tab of your organization:
|
||||
|
||||
7
.github/readme/partials/introduction.md
vendored
7
.github/readme/partials/introduction.md
vendored
@@ -1,5 +1,9 @@
|
||||
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!
|
||||
|
||||
<% if (/[.]0-beta$/.test(packaged.version)) { %>
|
||||
<sup>*⚠️ This is the documentation of **v<%= packaged.version.replace(/[.]0-beta$/, "") %>-beta** (`@master` branch) which includes [unreleased features](https://github.com/lowlighter/metrics/compare/latest...master), see documentation of **v<%= (Number(packaged.version.replace(/[.]0-beta$/, ""))-0.1).toFixed(1) %>** (`@latest` branch) [here](https://github.com/lowlighter/metrics/blob/latest/README.md).*</sup>
|
||||
<% } %>
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th align="center">For user accounts</th>
|
||||
@@ -13,6 +17,9 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
|
||||
let cell = 0
|
||||
const elements = Object.entries(plugins).filter(([key, value]) => (value)&&(!["base", "core"].includes(key)))
|
||||
%>
|
||||
|
||||
And you can customize these heavily with plugins, templates and hundreds of options!
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th colspan="2" align="center">
|
||||
|
||||
2
.github/readme/partials/setup/action.md
vendored
2
.github/readme/partials/setup/action.md
vendored
@@ -13,7 +13,7 @@ Assuming your username is `my-github-user`, you can then embed rendered metrics
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>💬 How to setup?</summary>
|
||||
<summary><b>💬 How to setup?</b> <i>(click to expand)</i></summary>
|
||||
|
||||
### 0. Setup your personal repository
|
||||
|
||||
|
||||
2
.github/readme/partials/setup/shared.md
vendored
2
.github/readme/partials/setup/shared.md
vendored
@@ -9,7 +9,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.
|
||||
|
||||
<details>
|
||||
<summary>💬 Fair use</summary>
|
||||
<summary><b>💬 Fair use</b> <i>(click to expand)</i></summary>
|
||||
|
||||
To ensure service availability, shared instance has a few limitations:
|
||||
* Images are cached for 15 minutes
|
||||
|
||||
2
.github/readme/partials/setup/web.md
vendored
2
.github/readme/partials/setup/web.md
vendored
@@ -11,7 +11,7 @@ Assuming your username is `my-github-user`, you can then embed rendered metrics
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>💬 How to setup?</summary>
|
||||
<summary><b>💬 How to setup?</b> <i>(click to expand)</i></summary>
|
||||
|
||||
### 0. Prepare your server
|
||||
|
||||
|
||||
Reference in New Issue
Block a user