The simplest way to include a Heroku badge in your README file.

The idea was blatantly stolen from the heroku-badge project.

Markdown:

![Heroku](https://pyheroku-badge.fly.dev/?app=<HEROKU_APP_NAME>&path=<ROUTE>&style=<STYLE>)

reStructuredText:

.. image:: https://pyheroku-badge.fly.dev/?app=<HEROKU_APP_NAME>&path=<ROUTE>&style=<STYLE>
   :target: https://<HEROKU_APP_NAME>.herokuapp.com
   :alt: Heroku

Textile:

!https://pyheroku-badge.fly.dev/?app=<HEROKU_APP_NAME>&path=<ROUTE>&style=<STYLE>!:https://<HEROKU_APP_NAME>.herokuapp.com

flat (Default)	flat-square	plastic

• Heroku badge shows timeout

Most likely your app is using free dynos and goes to sleep after 30 minutes of inactivity. If the app is sleeping, it takes roughly 15 seconds to get a response from the application. However, GitHub has a hard timeout for badges which is roughly 4 seconds.

While pyheroku-badge can work with any Heroku application, it has to return the badge in less than 4 seconds for GitHub to render it. If your app doesn't return a response for HTTP GET request fast enough, you will see the timeout badge.

The only solution would be to upgrade your app to the hobby plan.

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

Code and documentation are available according to the MIT License (see LICENSE).