sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
lowlighter
2020-09-18 12:57:47 +02:00
parent a6ffa0ffd2
commit a1d601361e
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -129,10 +129,13 @@ Assuming your username is `my-github-user`, you can embed your metrics in your p
<summary>💬 Restrictions and fair use</summary> <summary>💬 Restrictions and fair use</summary>
Since GitHub API has rate limitations and to avoid abuse, the shared instance has the following limitations : Since GitHub API has rate limitations and to avoid abuse, the shared instance has the following limitations :
* Images are cached for 1 day (meaning that your metrics won't be updated until the next day) * Images are cached for 2 hours
* A maximum of 1000 users can use this service * Your generated metrics **won't** be updated during this amount of time
* You're limited to 3 requests per hour (cached metrics are not counted) * If you enable or disable plugins by changing the url parameters, you'll need to wait before changes are applied
* Plugins are not available * You're limited to 3 requests per 2 hours
* Restriction **does not** apply to already cached users metrics, including your own
* Most of plugins are not available
* PageSpeed plugin can be enabled by passing `?pagespeed=1`, but metrics generation can take up some time
You should consider deploying your own instance or use GitHub Action if you're planning using this service. You should consider deploying your own instance or use GitHub Action if you're planning using this service.