You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+13-2
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,17 @@
23
23
MtheBot_ is an open-source project by [Mitchell Adair](https://github.com/mitchwadair), aiming to build an easy-to-use chat bot for Twitch. Chat bots on Twitch help to provide a rewarding and engaging experience for a broadcaster's viewers. In order to provide such an experience, often times a broadcaster must do a lot of additional work and research to allow for complicated commands to work in their chat. The goal of MtheBot_ is to minimize the amount of extra work a broadcaster must to in order to provide their chat with an enjoyable experience. The project started as a way to make a uniquely customizable bot for my own [Twitch channel](https://www.twitch.tv/mtheb). I quickly realized that I could generalize the bot and make it available for other people to use as well.
24
24
25
25
# How can I support MtheBot_?
26
-
MtheBot_ is currently a one-man operation. Because of this, I incur numerous monthly costs associated with keeping the bot running, which I currently pay out of pocket. These costs include domain registration and maintenance, server architechture, and more. If you would like to help keep MtheBot_ running, you could consider supporting the project on [Patreon](https://www.patreon.com/mitchdev). Anything is appreciated and will directly help the efforts being made not only to maintain MtheBot_, but also to allow me to dedicate more time to improving the bot and it's features.
26
+
MtheBot_ is currently a one-man operation. Because of this, I incur numerous monthly costs associated with keeping the bot running, which I currently pay out of pocket. These costs include domain registration and maintenance, server architechture, and more. If you would like to help keep MtheBot_ running, you could consider supporting the project on [Patreon](https://www.patreon.com/mitchdev) or giving a one-time donation through [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=9WS3KJPAV8JDJ&item_name=Supporting+the+Development+of+MtheBot_¤cy_code=USD&source=url). Anything is appreciated and will directly help the efforts being made not only to maintain MtheBot_, but also to allow me to dedicate more time to improving the bot and it's features.
@@ -44,6 +54,7 @@ MtheBot_ is currently a one-man operation. Because of this, I incur numerous mo
44
54
</p>
45
55
46
56
MtheBot_ is built using [tmi.js](https://github.com/tmijs/tmi.js). The back-end is built using a custom API server which hosts both a private API used by the front-end as well as a public API for general data (used in the "users" tag on this repo for example). The bot's back end is run through [AWS Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk/) and uses a [MySQL](https://www.mysql.com/) database attached to the EB environment.
57
+
47
58
## The Web Application
48
59
<palign="center">
49
60
<a href="https://vuejs.org/">
@@ -55,7 +66,7 @@ MtheBot_ is built using [tmi.js](https://github.com/tmijs/tmi.js). The back-end
55
66
</a>
56
67
</p>
57
68
58
-
MtheBot_ was a learning opportunity for me. At work, I use React so I took this opportunity to learn a new front-end framework. So, as a result, I went with [Vue](https://vuejs.org/). In addition to Vue, I utilized the [Vuetify](https://vuetifyjs.com/) design library to make the application pretty.
69
+
The official web application for MtheBot_ was a learning opportunity for me. At work, I use React so I took this opportunity to learn a new front-end framework. So, as a result, I went with [Vue](https://vuejs.org/). In addition to Vue, I utilized the [Vuetify](https://vuetifyjs.com/) design library to make the application pretty.
59
70
60
71
# Contribute
61
72
MtheBot_ is an open-source project and I welcome contributions to it! I will do my best to review pull requests in a timely manner. Documentation on getting started with developing for MtheBot_ as well as API reference can be found in the [doc](doc) section of this repository.
0 commit comments