docs: update shared setup
This commit is contained in:
BIN
.github/readme/imgs/setup_shared.dark.png
vendored
Normal file
BIN
.github/readme/imgs/setup_shared.dark.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 260 KiB |
BIN
.github/readme/imgs/setup_shared.light.png
vendored
Normal file
BIN
.github/readme/imgs/setup_shared.light.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 225 KiB |
@@ -1,19 +1,37 @@
|
|||||||
# 💕 Using the shared instance (~1 min setup, but with limitations)
|
# 💕 Using the shared instance (~1 min)
|
||||||
|
|
||||||
For convenience, you can use the shared instance available at [metrics.lecoq.io](https://metrics.lecoq.io) without any additional setup.
|
For convenience, a free shared instance is available at [metrics.lecoq.io](https://metrics.lecoq.io) without any additional setup.
|
||||||
|
|
||||||
|
## 0️ Setup a personal repository
|
||||||
|
|
||||||
|
Create a repository with the same name as your GitHub login (if it doesn't exist).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Its `README.md` will be displayed on your user profile:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## 2️ Configure *metrics*
|
||||||
|
|
||||||
|
Visit [metrics.lecoq.io](https://metrics.lecoq.io) and start playing around!
|
||||||
|
|
||||||
|
> ⚠️ Some plugins are not available on the web instance. Consider using [GitHub action](https://github.com/marketplace/actions/metrics-embed) to enjoy all features!
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
> ⚠️ 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!
|
||||||
|
|
||||||
|
> 💕 If you really enjoy this service, consider [sponsoring me](https://github.com/sponsors/lowlighter) to help me cover server costs!
|
||||||
|
|
||||||
|
## 3️ Add images to your profile `README.md`
|
||||||
|
|
||||||
|
Update profile `README.md` to include rendered image.
|
||||||
|
|
||||||
|
*Example: add rendered image with markdown*
|
||||||
```markdown
|
```markdown
|
||||||

|

|
||||||
```
|
```
|
||||||
|
|
||||||
This is mostly intended for previews, to enjoy all features consider using GitHub Action instead.
|
> ⚠️ 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
|
||||||
Availability is not guaranteed.
|
|
||||||
|
|
||||||
To ensure service availability, shared instance has a few limitations:
|
|
||||||
* Images are cached for 1 hour
|
|
||||||
* Rendered metrics **won't be updated** during this time window when queried
|
|
||||||
* You can manually update rendering again your metrics on [metrics.lecoq.io](https://metrics.lecoq.io)
|
|
||||||
* A rate limiter is enabled to prevent denial of service (it doesn't affect already cached metrics)
|
|
||||||
* Some plugins may not be available
|
|
||||||
|
|
||||||
Service is provided free of charge, so please be gentle with it 🙂
|
|
||||||
|
|||||||
Reference in New Issue
Block a user