Update documentation

This commit is contained in:
lowlighter
2021-02-18 12:47:02 +01:00
parent 3099fea335
commit 7edcb6bb58
13 changed files with 16 additions and 53 deletions

View File

@@ -1,21 +0,0 @@
---
name: 🗳️ Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---
<!--
👋 Hi there!
Thanks for using metrics and helping us to improve!
Please:
- Check you're not duplicating an existing issue
- It is not mentioned in https://github.com/lowlighter/metrics/projects/1
- Add correct labeling
- Provide a clear and concise description
-->

View File

@@ -1,20 +0,0 @@
---
name: 💬 Question
about: Ask a question or request help
title: ''
labels: question
assignees: ''
---
<!--
👋 Hi there!
Thanks for using metrics!
Please:
- Search for similar issues
- Check documentation
- Provide a clear and concise description
-->

View File

@@ -3,7 +3,9 @@
Metrics is built to be easily customizable. Metrics is built to be easily customizable.
Fork this repository, switch used action from `lowlighter/metrics@latest` to your fork and start coding! Fork this repository, switch used action from `lowlighter/metrics@latest` to your fork and start coding!
To suggest a new feature, report a bug or ask for help, fill an [issue](https://github.com/lowlighter/metrics/issues) describing it. To report a bug fill an [issue](https://github.com/lowlighter/metrics/issues) describing it.
To suggest new features or requesting help to setup metrics, check out [discussions](https://github.com/lowlighter/metrics/discussions).
If you want to contribute, submit a [pull request](https://github.com/lowlighter/metrics/pulls). If you want to contribute, submit a [pull request](https://github.com/lowlighter/metrics/pulls).
Be sure to read [CONTRIBUTING.md](CONTRIBUTING.md) for more information about this. Be sure to read [CONTRIBUTING.md](CONTRIBUTING.md) for more information about this.

View File

@@ -53,7 +53,7 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
<table> <table>
<tr> <tr>
<th colspan="2" align="center"> <th colspan="2" align="center">
<a href="source/templates/README.md">🖼️ <%= elements.length-1 %> templates</a> <a href="source/templates/README.md">🖼️ <%= elements.length-1 %>+ templates</a>
</th> </th>
</tr> </tr>
<% if (elements.length%2) <% if (elements.length%2)

View File

@@ -1,4 +1,4 @@
### 🌸 Anilist ### 🌸 Anilist watch list and reading list"
The *anilist* plugin lets you display your favorites animes, mangas and characters from your [AniList](https://anilist.co) account. The *anilist* plugin lets you display your favorites animes, mangas and characters from your [AniList](https://anilist.co) account.

View File

@@ -1,4 +1,4 @@
name: "🌸 Anilist" name: "🌸 Anilist watch list and reading list"
cost: N/A cost: N/A
categorie: social categorie: social
supports: supports:

View File

@@ -1,4 +1,4 @@
### 🏅 Contributors ### 🏅 Repository contributors
The *contributors* plugin lets you display repositories contributors from a commit range, that can be specified through either sha, tags, branch, etc. The *contributors* plugin lets you display repositories contributors from a commit range, that can be specified through either sha, tags, branch, etc.

View File

@@ -1,4 +1,4 @@
name: "🏅 Contributors" name: "🏅 Repository contributors"
cost: N/A cost: N/A
categorie: github categorie: github
supports: supports:

View File

@@ -5,8 +5,10 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
<table> <table>
<td align="center"> <td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.introduction.svg"> <details><summary open>Account version</summary>
<details><summary>Repository version</summary> <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.introduction.svg">
</details>
<details><summary open>Repository version</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.introduction.repository.svg"> <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.introduction.repository.svg">
</details> </details>
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">

View File

@@ -1,4 +1,4 @@
### 📜 Licenses ### 📜 Repository licenses
⚠️ This is NOT legal advice, use at your own risk ⚠️ This is NOT legal advice, use at your own risk
💣 Do NOT enable this plugin on public web instances (plugin allows raw commands injection) 💣 Do NOT enable this plugin on public web instances (plugin allows raw commands injection)

View File

@@ -1,4 +1,4 @@
name: "📜 Licenses" name: "📜 Repository licenses"
cost: N/A cost: N/A
categorie: github categorie: github
supports: supports:

View File

@@ -1,4 +1,4 @@
### 🗂️ Projects ### 🗂️ Active projects
⚠️ This plugin requires a personal token with public_repo scope. ⚠️ This plugin requires a personal token with public_repo scope.

View File

@@ -1,4 +1,4 @@
name: "🗂️ Projects" name: "🗂️ Active projects"
cost: 1 GraphQL request + 1 GraphQL request per repository project cost: 1 GraphQL request + 1 GraphQL request per repository project
categorie: github categorie: github
supports: supports: