diff --git a/README.md b/README.md index 6c6e350..375d7d3 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -# 3d-contributions \ No newline at end of file +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)). + +``` +?username=&year= +``` + +Example: https://3d-contributions.vercel.app/?username=jasonlong&year=2018 + +#### Development + +I've been using `vercel` for local dev. To load up a local server: `vercel dev`.