Skip to content

Commit

Permalink
Merge pull request #1 from diazgabe/update-readme
Browse files Browse the repository at this point in the history
Update readme and license
  • Loading branch information
diazgabe committed Jul 6, 2020
2 parents f325221 + 0fa6d81 commit ab6e4f8
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Gabriel Diaz

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# PollBot

## Installation
To host your own instance of the PollBot, clone this repository using [Visual Studio 2019](https://www.visualstudio.com/downloads/) or [download the release package](https://github.com/diazgabe/PollBot/releases) and update the **config.json** file.

## Configuration
```
prefix The prefix of commands that this bot will respond to. Default: "!"
token Your Discord bot token
```

## Commands
```
!help Displays the help message
!deleteCommands Configures the bot to delete commands after executing them
!keepCommands Configures the bot to keep commands after executing them
!poll Creates a reaction poll. Syntax is as follows: !poll [option1(reaction1) ... optionN(reactionN)]
Example: !poll a(😄), b(😜), c(😍)
```

## License

[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

0 comments on commit ab6e4f8

Please sign in to comment.