burnchart icon indicating copy to clipboard operation
burnchart copied to clipboard

Any way to integrate it in the README.md?

Open brunofin opened this issue 7 years ago • 1 comments

It would be super useful to be able to integrate the burndown chart to README.me. This way, we could have the current milestone statistics right in the project home page.

I imagine this could be easily achieved by creating an endpoint which dynamically returns an image. This endpoint could implement a few caching strategies to not overwhelm the server for example keep in cache for 24 hours or 12 hours.

Since it can require authentication for some repositories, some kind of Token could be provided by URL parameters, this Token being generated on config time during first authentication.

This way, it would be completely compatible with the Markdown syntax.

brunofin avatar Jun 14 '17 09:06 brunofin

Bruno, Burnchart is intended to be run from GitHub Pages without the need of a service. Currently it's not possible to dynamically render an image so that it can be pointed to using the <img src="" /> syntax.

I'd recommend using a url to image service that doesn't cache the image and point it to a specific theme-less specific chart that you'd like to display, e.g.: http://radekstepan.com/burnchart/?theme=raw#!/zcash/zcash

radekstepan avatar Jun 15 '17 02:06 radekstepan