From 2ab7a07784d308e4fbe3534d36a24019ed10fa26 Mon Sep 17 00:00:00 2001 From: mctaylors <95250141+mctaylors@users.noreply.github.com> Date: Wed, 17 May 2023 13:41:23 +0300 Subject: [PATCH] Update README.md (#39) --- .github/README.md | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/.github/README.md b/.github/README.md index 15bc0ff..ee86305 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,17 +1,27 @@ -![Boyfriend-Dark](https://user-images.githubusercontent.com/95250141/206895339-ef5510c8-8b30-4887-b89c-5dc14a24b18a.png#gh-dark-mode-only) -![Boyfriend-Light](https://user-images.githubusercontent.com/95250141/206895340-3415d97d-91fd-4fb6-8c17-4e1bf340e1df.png#gh-light-mode-only) + + + + + + + Boyfriend Logo + + ![GitHub License](https://img.shields.io/github/license/TeamOctolings/Boyfriend) ![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) -## Building -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 -``` +Beep! I'm a general-purpose bot for moderation written by [@Octol1ttle](https://github.com/Octol1ttle) in C# and Discord.Net -## Initial setup -Create `token.txt` in `Boyfriend/bin/Debug/net7.0/` and enter your bot token. Then, run `Boyfriend.exe`. +# 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!* + +# Getting Started + +You can read our [wiki](https://github.com/TeamOctolings/Boyfriend/wiki) in order to assemble your Boyfriend™ and moderate the server.