Question 1

How do I embed a progress bar in my GitHub README?

Accepted Answer

Use the SVG format: ![Progress](https://api.gru0.dev/progress/v1/year?format=svg). Replace 'year' with 'day' or use custom value/max parameters.

Question 2

Can I use custom values instead of date-based progress?

Accepted Answer

Yes! Pass ?value=847&max=1000 for any custom metric. Date ranges with ?start=&end= are also supported via the same endpoint.

Question 3

What output formats are available?

Accepted Answer

Six formats: text (raw number), ascii (unicode bar, 6 styles), svg (vector image), json (structured data), element (web component), iframe (embeddable frame).

Question 4

Is the progress bar timezone aware?

Accepted Answer

Yes. Pass any IANA timezone via ?tz=. Falls back to proxy headers (auto-detected from IP), then UTC.

Question 5

Does it work with Notion or other sites?

Accepted Answer

Yes. Use the script tag embed for any HTML page including Notion embeds, or use the SVG/img format for markdown-based platforms.

Question 6

Can I customize the colors and appearance?

Accepted Answer

Yes. Set color and bg attributes on the web component element, or pass ?color=&bg= for SVG images. Any valid CSS color is supported.