Skip to content

Commit

Permalink
Updated the README
Browse files Browse the repository at this point in the history
- Updated the installation instructions.
- Updated the API tokens section.
  • Loading branch information
CriticalFlaw authored Jan 30, 2020
1 parent a8c8d37 commit 03d554f
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
[![Appveyor Status](https://ci.appveyor.com/api/projects/status/6hw48u0v6muwxvvo?svg=true)](https://ci.appveyor.com/project/CriticalFlaw/flawbot)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1747be5dd35645369b747b81cc86701c)](https://www.codacy.com/app/CriticalFlaw/FlawBOT?utm_source=github.com&utm_medium=referral&utm_content=CriticalFlaw/FlawBOT&utm_campaign=Badge_Grade)

A Discord bot written in C# using the [DSharpPlus](https://github.com/DSharpPlus/DSharpPlus) library. This bot is not being hosted online, however you're welcome to fork this repository and host it yourself or reuse the code for your own bot, as long as you credit it. The complete list of commands and other documentation can be found [here](https://github.com/CriticalFlaw/FlawBOT/wiki).
A Discord bot written in C# using the [DSharpPlus](https://github.com/DSharpPlus/DSharpPlus) library. This bot is not being hosted online, however you're welcome to fork this repository and host it yourself or reuse the code for your own bot, as long as you credit it properly. The complete list of commands and other documentation can be found [here](https://github.com/CriticalFlaw/FlawBOT/wiki).

## Invite
[Click here to invite FlawBOT to your server](https://discordapp.com/oauth2/authorize?client_id=339833029013012483&scope=bot&permissions=66186303). Please note that the bot will only be online periodically for testing purposes.

## Installation
To run your own instance of FlawBOT, download and compile this repository in [Visual Studio 2019](https://www.visualstudio.com/downloads/). Modify the provided **config.json** file, adding the required API tokens.
To run your own instance of FlawBOT, [clone this repository](https://github.com/CriticalFlaw/FlawBOT/archive/master.zip) or [download the release package](https://github.com/CriticalFlaw/FlawBOT/releases) and modify the provided **config.json** file, adding the API tokens. If you're cloning the repository, use [Visual Studio 2019](https://www.visualstudio.com/downloads/) to compile the project.

## API Tokens
* [Discord](https://discordapp.com/developers/applications/me) (*required*)
Expand All @@ -18,6 +18,7 @@ To run your own instance of FlawBOT, download and compile this repository in [Vi
* [Imgur](https://api.imgur.com/oauth2/addclient)
* [OMDB](http://www.omdbapi.com/apikey.aspx)
* [Twitch](https://dev.twitch.tv/dashboard/apps/create)
* [NASA](https://api.nasa.gov/)
* [Teamwork.TF](https://teamwork.tf/api)
* [Backpack.TF](https://backpack.tf/developer)
* [Reddit](https://www.reddit.com/prefs/apps)
* [News API](https://newsapi.org/)
* [GoodReads](https://www.goodreads.com/api)

0 comments on commit 03d554f

Please sign in to comment.