Update README.md to remove frenchy punctuation accent
This commit is contained in:
1
.github/workflows/workflow.yml
vendored
1
.github/workflows/workflow.yml
vendored
@@ -8,6 +8,7 @@ on:
|
|||||||
paths-ignore:
|
paths-ignore:
|
||||||
- '**/*.md'
|
- '**/*.md'
|
||||||
- '**/*.png'
|
- '**/*.png'
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
|
|||||||
28
README.md
28
README.md
@@ -2,11 +2,11 @@
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Generate your metrics that you can embed everywhere, including your GitHub profile readme !
|
Generate your metrics that you can embed everywhere, including your GitHub profile readme!
|
||||||
|
|
||||||
[](https://metrics.lecoq.io)
|
[](https://metrics.lecoq.io)
|
||||||
|
|
||||||
But there's more with [plugins](https://github.com/lowlighter/metrics/tree/master/source/plugins) and [templates](https://github.com/lowlighter/metrics/tree/master/source/templates) !
|
But there's more with [plugins](https://github.com/lowlighter/metrics/tree/master/source/plugins) and [templates](https://github.com/lowlighter/metrics/tree/master/source/templates)!
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -177,7 +177,7 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste
|
|||||||
<tr>
|
<tr>
|
||||||
<td colspan="2" align="center">
|
<td colspan="2" align="center">
|
||||||
<a href="https://github.com/lowlighter/metrics/projects/1">
|
<a href="https://github.com/lowlighter/metrics/projects/1">
|
||||||
More to come soon !
|
More to come soon!
|
||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@@ -197,7 +197,7 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th>Repository template<br><sup>A special template to embed on any repository readme !</sup></th>
|
<th>Repository template<br><sup>A special template to embed on any repository readme!</sup></th>
|
||||||
<th></th>
|
<th></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -210,22 +210,22 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste
|
|||||||
<tr>
|
<tr>
|
||||||
<td colspan="2" align="center">
|
<td colspan="2" align="center">
|
||||||
<a href="https://github.com/lowlighter/metrics/projects/1">
|
<a href="https://github.com/lowlighter/metrics/projects/1">
|
||||||
More to come soon !
|
More to come soon!
|
||||||
</a>
|
</a>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
## 🦑 Interested to get your own ?
|
## 🦑 Interested to get your own?
|
||||||
|
|
||||||
Try it now at [metrics.lecoq.io](https://metrics.lecoq.io/) with your GitHub username !
|
Try it now at [metrics.lecoq.io](https://metrics.lecoq.io/) with your GitHub username!
|
||||||
|
|
||||||
Because some plugins require additional configuration and setup, some of them are not available at [metrics.lecoq.io](https://metrics.lecoq.io/).
|
Because some plugins require additional configuration and setup, some of them are not available at [metrics.lecoq.io](https://metrics.lecoq.io/).
|
||||||
For a fully-featured experience, consider using this as a [GitHub Action](https://github.com/marketplace/actions/github-metrics-as-svg-image) instead !
|
For a fully-featured experience, consider using this as a [GitHub Action](https://github.com/marketplace/actions/github-metrics-as-svg-image) instead!
|
||||||
|
|
||||||
[](https://github.com/lowlighter/downtime)
|
[](https://github.com/lowlighter/downtime)
|
||||||
|
|
||||||
# 📜 How to use ?
|
# 📜 How to use?
|
||||||
|
|
||||||
## ⚙️ Using GitHub Action on your profile repository (~5 min setup)
|
## ⚙️ Using GitHub Action on your profile repository (~5 min setup)
|
||||||
|
|
||||||
@@ -239,7 +239,7 @@ Assuming your username is `my-github-user`, you can then embed your metrics in y
|
|||||||
```
|
```
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>💬 How to setup ?</summary>
|
<summary>💬 How to setup?</summary>
|
||||||
|
|
||||||
### 0. Prepare your personal repository
|
### 0. Prepare your personal repository
|
||||||
|
|
||||||
@@ -303,14 +303,14 @@ When using a token with additional permissions, it is advised to fork this repos
|
|||||||
```yaml
|
```yaml
|
||||||
- uses: my-github-username/metrics@latest
|
- uses: my-github-username/metrics@latest
|
||||||
```
|
```
|
||||||
In this case, consider watching new releases of this repository to stay up-to-date and enjoy latest features !
|
In this case, consider watching new releases of this repository to stay up-to-date and enjoy latest features!
|
||||||
|
|
||||||
#### Preview vs release
|
#### Preview vs release
|
||||||
|
|
||||||
It is possible to use `@master` instead of `@latest` to use new features before their official release.
|
It is possible to use `@master` instead of `@latest` to use new features before their official release.
|
||||||
Breaking changes may occur occasionally on `@master`, which could result in your metrics not being generated temporarily.
|
Breaking changes may occur occasionally on `@master`, which could result in your metrics not being generated temporarily.
|
||||||
|
|
||||||
#### What will happen ?
|
#### What will happen?
|
||||||
|
|
||||||
A new metrics image will be generated and committed to your repository on each run.
|
A new metrics image will be generated and committed to your repository on each run.
|
||||||
|
|
||||||
@@ -366,7 +366,7 @@ When sharing an instance, it is advised to restrict the number of users which ca
|
|||||||
See all supported options in [settings.example.json](settings.example.json).
|
See all supported options in [settings.example.json](settings.example.json).
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>💬 How to setup ?</summary>
|
<summary>💬 How to setup?</summary>
|
||||||
|
|
||||||
### 0. Prepare your server
|
### 0. Prepare your server
|
||||||
|
|
||||||
@@ -504,7 +504,7 @@ Basically, most of [action.yml](action.yml) options can actually be used by web
|
|||||||
Templates allows you to change the general appearance of your metrics images.
|
Templates allows you to change the general appearance of your metrics images.
|
||||||
Some metrics may be displayed differently, and all plugins may not be supported or behave the same from one template to another.
|
Some metrics may be displayed differently, and all plugins may not be supported or behave the same from one template to another.
|
||||||
|
|
||||||
Consider trying them at [metrics.lecoq.io](https://metrics.lecoq.io) !
|
Consider trying them at [metrics.lecoq.io](https://metrics.lecoq.io)!
|
||||||
|
|
||||||
Used template defaults to the `classic` one.
|
Used template defaults to the `classic` one.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user