|
1 | | -# 💕 Using the shared instance (~1 min setup, but with limitations) |
| 1 | +# 💕 Using the shared instance (~1 min) |
2 | 2 |
|
3 | | -For convenience, you can use the shared instance available at [metrics.lecoq.io](https://metrics.lecoq.io) without any additional setup. |
| 3 | +For convenience, a free shared instance is available at [metrics.lecoq.io](https://metrics.lecoq.io) without any additional setup. |
4 | 4 |
|
5 | | -```markdown |
6 | | - |
7 | | -``` |
| 5 | +## 0️ Setup a personal repository |
| 6 | + |
| 7 | +Create a repository with the same name as your GitHub login (if it doesn't exist). |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +Its `README.md` will be displayed on your user profile: |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +## 2️ Configure *metrics* |
| 16 | + |
| 17 | +Visit [metrics.lecoq.io](https://metrics.lecoq.io) and start playing around! |
8 | 18 |
|
9 | | -This is mostly intended for previews, to enjoy all features consider using GitHub Action instead. |
10 | | -Availability is not guaranteed. |
| 19 | +> ⚠️ Some plugins are not available on the web instance. Consider using [GitHub action](https://github.com/marketplace/actions/metrics-embed) to enjoy all features! |
11 | 20 |
|
12 | | -To ensure service availability, shared instance has a few limitations: |
13 | | - * Images are cached for 1 hour |
14 | | - * Rendered metrics **won't be updated** during this time window when queried |
15 | | - * You can manually update rendering again your metrics on [metrics.lecoq.io](https://metrics.lecoq.io) |
16 | | - * A rate limiter is enabled to prevent denial of service (it doesn't affect already cached metrics) |
17 | | - * Some plugins may not be available |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | +> ⚠️ This service is hosted on a small server that I rent. It is provided free of charge so please be gentle with it 😅 Availability not guaranteed! |
| 25 | +
|
| 26 | +> 💕 If you really enjoy this service, consider [sponsoring me](https://github.com/sponsors/lowlighter) to help me cover server costs! |
| 27 | +
|
| 28 | +## 3️ Add images to your profile `README.md` |
| 29 | + |
| 30 | +Update profile `README.md` to include rendered image. |
| 31 | + |
| 32 | +*Example: add rendered image with markdown* |
| 33 | +```markdown |
| 34 | + |
| 35 | +``` |
18 | 36 |
|
19 | | -Service is provided free of charge, so please be gentle with it 🙂 |
| 37 | +> ⚠️ Images are cached for 1 hour after being rendered. They **won't be updated** during this time window when queried again. However it is possible to manually update them by using [metrics.lecoq.io](https://metrics.lecoq.io) again |
0 commit comments