Octobot/docs/README.md

<p align="center">
    <img src="https://mctaylors.ddns.net/cdn/octobot-banner.png" alt="Octobot banner"/>
</p>

![License](https://img.shields.io/github/license/LabsDevelopment/Octobot)
![Workflow Status](https://img.shields.io/github/actions/workflow/status/LabsDevelopment/Octobot/.github/workflows/build-push.yml?branch=master&logo=ReSharper)
![Last Commit](https://img.shields.io/github/last-commit/LabsDevelopment/Octobot)

Veemo! I'm a general-purpose bot for moderation (formerly known as Boyfriend) written by [@Octol1ttle](https://github.com/Octol1ttle) in C# and Remora.Discord

## Features

* Banning, muting, kicking, etc.
* Reminding you about something if you wish
* Reminding everyone about that new event you made
* Log everything from joining the server to deleting messages

*...and more!*

## Installing and running Octobot

You can read our [wiki](https://github.com/LabsDevelopment/Octobot/wiki) in order to assemble your Octobot and
moderate the server.

## Contributing

When it comes to contributing to the project, the two main things you can do to help out are reporting issues and
submitting pull requests. Please refer to the [contributing guidelines](CONTRIBUTING.md) to understand how to help in
the most effective way possible.

## Special Thanks

![JetBrains Logo (Main) logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)

[JetBrains](https://www.jetbrains.com/), creators of [ReSharper](https://www.jetbrains.com/resharper)
and [Rider](https://www.jetbrains.com/rider), supports Octobot with one of
their [Open Source Licenses](https://jb.gg/OpenSourceSupport).
Rider is the recommended IDE when working with Octobot, and everyone on the Octobot team uses it.
Additionally, ReSharper command-line tools made by JetBrains are used for status checks on pull requests to ensure code
quality even when not using ReSharper or Rider.