From 6ee55c45635034d7a69b88697dd3c1a222b3e854 Mon Sep 17 00:00:00 2001 From: CrimsonTome Date: Wed, 12 Oct 2022 16:34:22 +0100 Subject: [PATCH] add license header and tldr link --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 42e2fb0..72aae23 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ## HullCSS Discord Bot -This bot is a multipurpose discord bot for The Hull Computer Science Society Discord server. +This bot is a multipurpose discord bot for The Hull Computer Science Society Discord server. @@ -29,10 +29,10 @@ Alongside commands, this bot also features: * Rule agreement button embed with `#code-of-conduct` --- -## Installation -**This is a private bot used for a specific purpose within a specific discord server however if you do want to run the bot for testing purposes or deploy it to a new location. Follow the instructions below.** +## Installation +**This is a private bot used for a specific purpose within a specific discord server however if you do want to run the bot for testing purposes or deploy it to a new location. Follow the instructions below.** -### 🐋 Docker +### 🐋 Docker Due to the [Publish.yml](.github/workflows/publish.yml) workflow, the newest build will automatically be pushed to dockerhub. ```docker @@ -48,7 +48,7 @@ kieranr27/hullcss:main Using a tool like [Ouroboros](https://github.com/pyouroboros/ouroboros), you can automatically update containers without the need for restarts. ### 👷 Manual -- Clone the repo +- Clone the repo - Remove the `.template` from `.env.template` - Replace `INSERT DISCORD TOKEN` with your Discord token. - Run `npm i` to install packages @@ -56,5 +56,9 @@ Using a tool like [Ouroboros](https://github.com/pyouroboros/ouroboros), you can --- ## Contributions -While this bot is maintained by [Kieran](https://github.com/KieranRobson), contributors are welcome! -- Contribution guidelines are coming soon. \ No newline at end of file +While this bot is maintained by [Kieran](https://github.com/KieranRobson), contributors are welcome! +- Contribution guidelines are coming soon. + +## License + +hullcss-discord-bot is licensed under the MIT License. The full license text is included in the [LICENSE](LICENSE) file in this repository. Tldr legal have a [great summary](https://www.tldrlegal.com/l/mit) of the license if you're interested. \ No newline at end of file