1
0
Fork 1
mirror of https://github.com/TeamOctolings/Octobot.git synced 2025-04-20 00:43:36 +03:00

Update README.md

This commit is contained in:
Macintxsh 2023-05-15 19:43:53 +03:00 committed by GitHub
parent 02949656bf
commit 081a36e120
Signed by: GitHub
GPG key ID: 4AEE18F83AFDEB23

21
.github/README.md vendored
View file

@ -5,13 +5,16 @@
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/TeamOctolings/Boyfriend/.github/workflows/resharper.yml?branch=master) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/TeamOctolings/Boyfriend/.github/workflows/resharper.yml?branch=master)
![GitHub last commit](https://img.shields.io/github/last-commit/TeamOctolings/Boyfriend) ![GitHub last commit](https://img.shields.io/github/last-commit/TeamOctolings/Boyfriend)
## Building Beep! I'm a general-purpose bot for moderation written by [@Octol1ttle](https://github.com/Octol1ttle) in C# and Discord.Net
To build Boyfriend, you need to clone this repo and compile it with [.NET 7](https://dotnet.microsoft.com/download/dotnet/7.0).
```
git clone https://github.com/TeamOctolings/Boyfriend
cd Boyfriend
dotnet build
```
## Initial setup # Features
Create `token.txt` in `Boyfriend/bin/Debug/net7.0/` and enter your bot token. Then, run `Boyfriend.exe`. * Banning, muting, kicking, etc.
* Reminding you about something if you wish
* Reminding everyone about that new event you made
* Log everything from joining to the server to deleting messages
*...and more!*
# Getting Started
You can read our [wiki](https://github.com/TeamOctolings/Boyfriend/wiki) in order to assemble your Boyfriend™ and moderate the server.