Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Any way to integrate it in the README.md? #125

Open
brunofin opened this issue Jun 14, 2017 · 1 comment
Open

Any way to integrate it in the README.md? #125

brunofin opened this issue Jun 14, 2017 · 1 comment

Comments

@brunofin
Copy link

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.

@radekstepan
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants