taigrr/skyline
1
0
Fork 0
mirror of https://github.com/taigrr/skyline synced 2025-01-18 04:33:13 -08:00
Code Issues Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Martin Woodward 2020-12-16 10:07:01 +00:00
parent b6d98c07de
commit 6f187e59cb
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,11 +1,20 @@
Given a Github username and a year, renders a 3D model of their contribution chart. The data is fetched via a server less function ([repo](https://github.com/jasonlong/json-contributions)).
Given a Github username and a year, renders a 3D model of their contribution chart. The data is fetched via a serverless function ([repo](https://github.com/martinwoodward/json-contributions) which also calculates distribution data).
```
?username=<username>&year=<year>
```
Example: https://3d-contributions.vercel.app/?username=jasonlong&year=2018
If no year is provided, the current year will be used.
Examples:
- https://skyline.martinwoodward.vercel.app/?username=martinwoodward
- https://skyline.martinwoodward.vercel.app/?username=martinwoodward&year=2020
- https://skyline.martinwoodward.vercel.app/?username=mdo&year=2020
#### Development
I've been using `vercel` for local dev. To load up a local server: `vercel dev`.
Note that this version creates a distribution from the 90th percentile on the contributions per day to stop the odd _really_ big days blowing out the scale. It also has a default minimum for non-zero contribition days (10% of the maximum height)