shared.md

💕 Using the shared instance (~1 min)

For convenience, a free shared instance is available at 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 and start playing around!

⚠️ Some plugins are not available on the web instance. Consider using GitHub action to enjoy all features!

ℹ️ metrics.lecoq.io always run on latest release. To test upcoming releases, use beta-metrics.lecoq.io, which always run on @master instead.

⚠️ 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 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

![Metrics](https://metrics.lecoq.io/username)

⚠️ 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 again