aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author8cy <[email protected]>2020-07-19 02:10:00 -0700
committer8cy <[email protected]>2020-07-19 02:10:00 -0700
commit4014ac46b4e5e515f133ca2c04859824cd43738c (patch)
tree5842824afd615f70e8a4959704f9cf3492fa54f2 /README.md
downloadwater-waifu-4014ac46b4e5e515f133ca2c04859824cd43738c.tar.xz
water-waifu-4014ac46b4e5e515f133ca2c04859824cd43738c.zip
:star:
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..275c25f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+<div align="center">
+<h1>Water Waifu</h1>
+<br>
+<strong><i>A bot that automatically assigns roles based on message reactions.</i></strong>
+<br>
+<br>
+<hr>
+
+<a href="https://travis-ci.com/8cy/water-waifu">
+ <img src="https://img.shields.io/travis/com/8cy/water-waifu.svg?style=for-the-badge" alt="Build">
+</a>
+
+<a href="https://github.com/8cy/water-waifu">
+ <img src="https://img.shields.io/github/languages/top/8cy/water-waifu.svg?colorB=f0db4f&style=for-the-badge" alt="Languages">
+</a>
+
+<br>
+
+<a href="https://github.com/8cy/water-waifu">
+ <img src="https://img.shields.io/github/package-json/v/8cy/water-waifu.svg?colorB=Orange&style=for-the-badge" alt="Version">
+</a>
+
+<a href="https://github.com/8cy/water-waifu/issues">
+ <img src="https://img.shields.io/github/issues/8cy/water-waifu.svg?style=for-the-badge&colorB=37f149" alt="Issues">
+</a>
+
+<a href="https://github.com/8cy/water-waifu/pulls">
+ <img src="https://img.shields.io/github/issues-pr/8cy/water-waifu.svg?style=for-the-badge&colorB=37f149" alt="Pull Request">
+</a>
+
+<br>
+<br>
+</div>
+<hr>
+<br>
+
+## Features
+
+- Customizable messages, reactions, command, and roles
+
+- Auto-removes role when user removes a reaction
+
+- Option to use an embed to have all options in one message
+
+- Error handling to let you know if something is wrong