diff --git a/README.md b/README.md new file mode 100644 index 0000000..b3384a7 --- /dev/null +++ b/README.md @@ -0,0 +1,106 @@ + + + + +

SkyBot

+ +

+SkyBot is a Valour.gg bot. +

+ +

Features

+ + +

Data & Privacy

+

SkyBot stores only the minimum data required for operation:

+ + +

SkyBot does not store:

+ + +

+Full privacy policy:
+ +https://github.com/SkyJoshua/SkyBot/blob/main/PRIVACY + +

+ +

License

+

+This project is licensed under the +GNU Affero General Public License v3.0 (AGPL-3.0). +

+ +

+See the LICENSE file for details:
+ +https://github.com/SkyJoshua/SkyBot/blob/main/LICENSE + +

+ +

+Because this project is licensed under AGPL-3.0, if you modify and deploy it +publicly (including as a hosted service), you must make your source code +available under the same license. +

+ +

Installation

+ +
git clone https://github.com/SkyJoshua/SkyBot.git
+cd SkyBot
+dotnet restore
+dotnet build
+
+ +

+All required NuGet packages will be installed automatically using the +provided SkyBot.csproj file. +

+ +

Running the Bot

+ +
dotnet run
+
+ +

Configuration

+

Before running the bot, create a .env file in the root directory of the project with the following content:

+ +
TOKEN=your-bot-token-here
+
+ + + +

+Sensitive data such as bot tokens should never be committed to the repository. +Use environment variables or secure configuration methods. +

+ +

Contributing

+

+Contributions are welcome. By submitting a contribution, you agree that your +contributions will be licensed under AGPL-3.0. +

+ +
    +
  1. Fork the repository
  2. +
  3. Create a feature branch
  4. +
  5. Submit a pull request
  6. +
+ + +