Skip to content

Commit a057693

Browse files
committed
docs: update shared setup
1 parent daf6670 commit a057693

File tree

3 files changed

+32
-14
lines changed

3 files changed

+32
-14
lines changed
260 KB
Loading
225 KB
Loading
Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,37 @@
1-
# 💕 Using the shared instance (~1 min setup, but with limitations)
1+
# 💕 Using the shared instance (~1 min)
22

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.
44

5-
```markdown
6-
![Metrics](https://metrics.lecoq.io/my-github-user)
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+
![Setup personal repository](/.github/readme/imgs/setup_personal_repository.png)
10+
11+
Its `README.md` will be displayed on your user profile:
12+
13+
![GitHub Profile Example](/.github/readme/imgs/example_github_profile.png)
14+
15+
## 2️ Configure *metrics*
16+
17+
Visit [metrics.lecoq.io](https://metrics.lecoq.io) and start playing around!
818

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!
1120
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+
![metrics.lecoq.io](/.github/readme/imgs/setup_shared.light.png#gh-light-mode-only)
22+
![metrics.lecoq.io](/.github/readme/imgs/setup_shared.dark.png#gh-dark-mode-only)
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+
![Metrics](https://metrics.lecoq.io/username)
35+
```
1836

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

Comments
 (0)