aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-06-24 15:06:43 -0700
committerFuwn <[email protected]>2021-06-24 15:06:43 -0700
commit2bccd50b7a11dda0ae239ce13efcdac118bfee92 (patch)
tree28f665461bb9746d70878071b11537d784a59842 /README.rst
downloaddos-bot-2bccd50b7a11dda0ae239ce13efcdac118bfee92.tar.xz
dos-bot-2bccd50b7a11dda0ae239ce13efcdac118bfee92.zip
feat(dos-bot): :star:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst66
1 files changed, 66 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..bddb16f
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,66 @@
+.. raw:: html
+
+ <h1 align="center"><code>dos-bot</code></h1>
+
+ <p align="center">
+
+.. image:: https://img.shields.io/discord/854071194453671976
+ :alt: Discord
+ :target: https://discord.io/assembly
+
+.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
+ :alt: Say Thanks
+ :target: https://saythanks.io/to/[email protected]
+
+.. image:: https://img.shields.io/github/license/fuwn/dos-bot
+ :alt: License
+ :target: ./LICENSE
+
+.. raw:: html
+
+ </p>
+
+Usage
+-----
+
+Docker
+~~~~~~
+
+.. code-block:: shell
+
+ $ docker run --name DosBot -v /var/lib/dos-bot:/.dos-bot fuwn/dos-bot
+
+Docker Compose
+~~~~~~~~~~~~~~
+
+.. code-block:: shell
+
+ $ docker-compose up -d
+
+Invite
+~~~~~~
+
+https://discord.com/api/oauth2/authorize?client_id=857695800677892106&permissions=8&scope=bot
+
+Development Dependencies
+------------------------
+
+Required
+~~~~~~~~
+
+- `Rust <https://www.rust-lang.org/>`_ — The backbone of it all.
+- `cargo-make <https://github.com/sagiegurari/cargo-make>`_ — Cross-platform
+ `make <https://www.gnu.org/software/make/>`_ substitute
+
+Optional
+~~~~~~~~
+
+- `cargo-watch <https://crates.io/crates/cargo-watch>`_ — Recompilation on file-system changes
+
+*These development dependencies (excluding sqlfluff) will automatically be satisfied if you are
+using the Nix shell configuration as provided.*
+
+License
+~~~~~~~
+
+`GNU General Public License v3.0 <./LICENSE>`_