diff --git a/README.md b/README.md index 87d7474..541b850 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,33 @@ -# shields.io for Patreon +# October 2020 - UPDATE -Custom endpoint to allow displaying Patreon's number of patrons or amount of pledges. It uses [shields.io's Endpoint feature](https://shields.io/#/endpoint). - -## ATTENTION - -Please deploy your own version of this on your own Heroku account. My version is -hosted on Heroku Free Plan, and can be unavaialble as soon as my usage expires -(usually in the last few days of each month). +- There is an alternative way to display the amount of patrons on your Patreon campaign [described here](https://github.com/endel/shieldsio-patreon/issues/8#issuecomment-700144629). +- I've turned off the `https://shieldsio-patreon.herokuapp.com` endpoint. +- If you'd like to continue using the endpoint implemented on this repository, click the link below to deploy it on your Heroku account, or deploy it on your own VPS server. Deploy +# shields.io for Patreon -## Usage: - -- Endpoint: `https://shieldsio-patreon.herokuapp.com/endel/pledges` -- Endpoint encoded: `https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fendel%2Fpledges` -- Using shields.io `endpoint`/`url`: `https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fendel%2Fpledges&style=for-the-badge` -- Result: - -See [shields.io's endpoint](https://shields.io/#/endpoint) for full documentation. - +Custom endpoint to allow displaying Patreon's number of patrons or amount of pledges. It uses [shields.io's Endpoint feature](https://shields.io/#/endpoint). ## Examples Show number of patrons: -``` -https://shieldsio-patreon.herokuapp.com/endel -``` +- Endpoint URL: `https://shieldsio-patreon.herokuapp.com/endel` +- Image SRC: `https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fendel&style=for-the-badge` - + Show pledges per month: -``` -https://shieldsio-patreon.herokuapp.com/endel/pledges -``` +- Endpoint URL: `https://shieldsio-patreon.herokuapp.com/endel/pledges` +- Image SRC: `https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fendel%2Fpledgesssss&style=for-the-badge` - + ## License diff --git a/preview/patrons.svg b/preview/patrons.svg new file mode 100644 index 0000000..49ccec2 --- /dev/null +++ b/preview/patrons.svg @@ -0,0 +1 @@ +PATREON: 26 PATRONSPATREON26 PATRONS \ No newline at end of file diff --git a/preview/pledges.svg b/preview/pledges.svg new file mode 100644 index 0000000..d21ea1a --- /dev/null +++ b/preview/pledges.svg @@ -0,0 +1 @@ +DONATIONS: $393/MODONATIONS$393/MO \ No newline at end of file