Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eritislami committed Jun 13, 2020
1 parent 1832316 commit 5d3b849
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
@@ -1,6 +1,6 @@
![logo](https://repository-images.githubusercontent.com/186841818/8aa95700-7730-11e9-84be-e80f28520325)

# EvoBot (Discord Music Bot)
# 馃 EvoBot (Discord Music Bot)
> EvoBot is a Discord Music Bot built with discord.js & uses Command Handler from [discordjs.guide](https://discordjs.guide)
## Requirements
Expand All @@ -9,7 +9,7 @@
2. YouTube Data API v3 Key **[Guide](https://developers.google.com/youtube/v3/getting-started)**
3. Node.js v12.0.0 or newer

## Installation
## 馃殌 Getting Started

```
git clone https://github.com/eritislami/evobot.git
Expand All @@ -21,7 +21,7 @@ After installation finishes you can use `node index.js` to start the bot.

If you are planning to use ***Glitch.com*** please read [#27](https://github.com/eritislami/evobot/issues/27)

## Configuration
## 鈿欙笍 Configuration

Copy or Rename `config.json.example` to `config.json` and fill out the values:

Expand All @@ -40,15 +40,20 @@ Copy or Rename `config.json.example` to `config.json` and fill out the values:
> Note: The default prefix is '/'
* 馃幎 Play music from YouTube via url
* `/play https://www.youtube.com/watch?v=GLvohMXgcBo`

`/play https://www.youtube.com/watch?v=GLvohMXgcBo`
* 馃攷 Play music from YouTube via search query
* `/play under the bridge red hot chili peppers`

`/play under the bridge red hot chili peppers`
* 馃攷 Search and select music to play
* `/search Pearl Jam`

`/search Pearl Jam`
* 馃搩 Play youtube playlists via url
* `/playlist https://www.youtube.com/watch?v=YlUKcNNmywk&list=PL5RNCwK3GIO13SR_o57bGJCEmqFAwq82c`

`/playlist https://www.youtube.com/watch?v=YlUKcNNmywk&list=PL5RNCwK3GIO13SR_o57bGJCEmqFAwq82c`
* 馃攷 Play youtube playlists via search query
* `/playlist linkin park meteora`

`/playlist linkin park meteora`
* Command Handler from [discordjs.guide](https://discordjs.guide/)
* Now Playing (/np)
* Queue system (/queue, /q)
Expand All @@ -64,7 +69,7 @@ Copy or Rename `config.json.example` to `config.json` and fill out the values:
* Media Controls via Reactions
![reactions](https://i.imgur.com/j7CevsH.png)

## Contributing
## 馃 Contributing

1. [Fork the repository](https://github.com/eritislami/evobot/fork)
2. Clone your fork: `git clone https://github.com/your-username/evobot.git`
Expand All @@ -73,6 +78,6 @@ Copy or Rename `config.json.example` to `config.json` and fill out the values:
5. Push to the branch: `git push origin my-new-feature`
6. Submit a pull request

## Credits
## 馃摑 Credits

[@iCrawl](https://github.com/iCrawl) For the queue system used in this application which was adapted from [@iCrawl/discord-music-bot](https://github.com/iCrawl/discord-music-bot)

0 comments on commit 5d3b849

Please sign in to comment.