Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
D3vd authored Dec 1, 2022
1 parent f523369 commit 7022620
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# Meme API

⚠️ Heroku has discontinued support for free Dynos, so the old Domain `meme-api.herokuapp.com` has stopped working ⚠️

Please update your apps to the new Domain `meme-api.com` to continue using the API

[![CodeFactor](https://www.codefactor.io/repository/github/d3vd/meme_api/badge)](https://www.codefactor.io/repository/github/d3vd/meme_api)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8df2a02ea3294423adc74bbf0a13356e)](https://www.codacy.com/gh/D3vd/Meme_Api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=D3vd/Meme_Api&utm_campaign=Badge_Grade)
[![DeepSource](https://deepsource.io/gh/D3vd/Meme_Api.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/D3vd/Meme_Api/?ref=repository-badge)

JSON API for a random meme scraped from reddit.

API Link : [https://meme-api.herokuapp.com/gimme](https://meme-api.herokuapp.com/gimme)
API Link : [https://meme-api.com/gimme](https://meme-api.com/gimme)

**Example Response:**

Expand Down Expand Up @@ -37,9 +41,9 @@ API Link : [https://meme-api.herokuapp.com/gimme](https://meme-api.herokuapp.com

In order to get multiple memes in a single request specify the count with the following endpoint.

Endpoint: [/gimme/{count}](https://meme-api.herokuapp.com/gimme/2)
Endpoint: [/gimme/{count}](https://meme-api.com/gimme/2)

Example: [https://meme-api.herokuapp.com/gimme/2](https://meme-api.herokuapp.com/gimme/2)
Example: [https://meme-api.com/gimme/2](https://meme-api.com/gimme/2)

Response:

Expand Down Expand Up @@ -86,9 +90,9 @@ Response:

By default the API grabs a random meme from '_memes_', '_dankmemes_', '_me_irl_' subreddits. To provide your own custom subreddit use the following endpoint.

Endpoint: [/gimme/{subreddit}](https://meme-api.herokuapp.com/gimme/wholesomememes)
Endpoint: [/gimme/{subreddit}](https://meme-api.com/gimme/wholesomememes)

Example: [https://meme-api.herokuapp.com/gimme/wholesomememes](https://meme-api.herokuapp.com/gimme/wholesomememes)
Example: [https://meme-api.com/gimme/wholesomememes](https://meme-api.com/gimme/wholesomememes)

Response:

Expand All @@ -115,9 +119,9 @@ Response:

In order to get a custom number of memes from a specific subreddit provide the name of the subreddit and the count in the following endpoint.

Endpoint: [/gimme/{subreddit}/{count}](https://meme-api.herokuapp.com/gimme/wholesomememes/2)
Endpoint: [/gimme/{subreddit}/{count}](https://meme-api.com/gimme/wholesomememes/2)

Example: [https://meme-api.herokuapp.com/gimme/wholesomememes/2](https://meme-api.herokuapp.com/gimme/wholesomememes/2)
Example: [https://meme-api.com/gimme/wholesomememes/2](https://meme-api.com/gimme/wholesomememes/2)

Response:

Expand Down

0 comments on commit 7022620

Please sign in to comment.