Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vteam27 authored Aug 14, 2022
1 parent 0d54c50 commit 728664d
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,44 @@
# RIF-bot
🤖RIF-bot is a simple and useful discord bot that can fetch images from any subreddit and post in your disord channel !

## Build-Setup

This bot was built in a [replit](https://replit.com) environment.
- Go to [replit](https://replit.com) and make an account if you don't already have one.
- Go to `create` and then select `import from github`
- Fork this Repo and enter your forked repo's URL.
- Enter your bot's `token` as an environment variable named `token`.
- Run !

## Usage
You can invite the RIF-bot to your discord server using this [invite!](https://discord.com/api/oauth2/authorize?client_id=1008103587374710854&permissions=412317178880&scope=bot)

The command syntax for this bot is : `?fetch [subreddit] [number of images]` , where `[subreddit]` & `[number of images]` are optional parameters. Here `[subreddit]` is the name of the subreddit without any `r/` prefix.<br><br> For more details see the examples below-

- To get a random image navigate to any channel in your server and type `?fetch`<br>

<p >
<img height="300" width="240" src="https://user-images.githubusercontent.com/94956831/184550939-be81b5c5-fbc1-49d4-a864-9cfe7c132cd3.png" />
</p>

- To get multiple random images use `?fetch [number of images]`<br>

<p >
<img height="500" width="370" src="https://user-images.githubusercontent.com/94956831/184551055-b3b03c30-0d5b-4d8d-af4b-5dbd8a6eaf24.png" />
</p>

- To get a single image from a particular subreddit type `?fetch [subreddit]`<br>

<p >
<img height="300" width="240" src="https://user-images.githubusercontent.com/94956831/184550973-1e63e0b1-610d-4807-b804-0d2b9bd887f6.png" />
</p>

- To get a number of images from a particular subreddit use `?fetch [subreddit] [number of images]`<br>

<p>
<img width="370" display=block src="https://user-images.githubusercontent.com/94956831/184551425-8b2b53b5-9bc4-4e28-bf8d-63e3e96d37e4.png" />
</p>
<p>
<img height="500" width="370" src="https://user-images.githubusercontent.com/94956831/184551016-285ffa96-dfc8-4224-b6bf-77fcaf06efef.png" />
</p>

0 comments on commit 728664d

Please sign in to comment.