Skip to content

Commit

Permalink
update readme. turning down my own personal endpoint.
Browse files Browse the repository at this point in the history
  • Loading branch information
endel committed Oct 15, 2020
1 parent f838d70 commit 70cad93
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 25 deletions.
37 changes: 12 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,33 @@
# shields.io for Patreon <a href="https://patreon.com/endel"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fendel%2Fpledgesssss&style=for-the-badge" /> </a>
# 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.

<a href="https://heroku.com/deploy?template=https://github.com/endel/shieldsio-patreon">
<img src="https://www.herokucdn.com/deploy/button.svg" alt="Deploy">
</a>

# shields.io for Patreon <a href="https://patreon.com/endel"><img src="https://img.shields.io/badge/dynamic/json?logo=patreon&style=for-the-badge&color=%23e85b46&label=Patreon&query=data.attributes.patron_count&suffix=%20supporters&url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F365642" /></a>

## 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: <a href="https://patreon.com/endel"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fendel%2Fpledgesssss&style=for-the-badge" /> </a>

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`

<a href="https://patreon.com/endel"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fendel&style=for-the-badge" /> </a>
<a href="https://patreon.com/endel"><img src="preview/patrons.svg?raw=1" /> </a>

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`

<a href="https://patreon.com/endel"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fendel%2Fpledgesssss&style=for-the-badge" /> </a>

<a href="https://patreon.com/endel"><img src="preview/pledges.svg?raw=1" /> </a>

## License

Expand Down
1 change: 1 addition & 0 deletions preview/patrons.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions preview/pledges.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 70cad93

@vercel
Copy link

@vercel vercel bot commented on 70cad93 Oct 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.