From 967492685adf3ce9adfdf55dd6f952a7a1a9d358 Mon Sep 17 00:00:00 2001 From: moonleay Date: Sun, 17 Sep 2023 13:17:14 +0200 Subject: [PATCH] chore: update README.md Signed-off-by: moonleay --- README.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 14b1834..acb019b 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,6 @@ A Discord Bot for Splatoon Teams -[![Latest Release](https://gitlab.com/moonleay/liljudd/-/badges/release.svg)](https://gitlab.com/moonleay/liljudd/-/releases) -[![pipeline status](https://gitlab.com/moonleay/liljudd/badges/master/pipeline.svg)](https://gitlab.com/moonleay/liljudd/-/commits/master) -[![License](https://img.shields.io/badge/license-GPL--3.0-brightgreen)](https://gitlab.com/moonleay/liljudd/-/blob/master/LICENSE) - ## Contributors [![Developer](https://img.shields.io/badge/moonleay-Developer-red)](https://gitlab.com/moonleay) @@ -33,36 +29,31 @@ A Discord Bot for Splatoon Teams - Rndm map command - Maybe a DSB / DSL API -## TODO - -- Rewrite the Database connection system (from transactions all over the place to a single package with transactions) - ## How to self-host (using the Docker container) -1. Pull the container +1. Pull the container from [Docker Hub](https://hub.docker.com/repository/docker/limiteddev/liljudd/general) 2. Map /data/ to a folder on disk 3. Run the Bot once -4. Follow step 4 - 7 of "How to self-host (using the JAR)" +4. follow step 4 and 5 from the JAR section +5. Run the Bot again +6. Profit. +7. ## How to self-host (using the JAR) -1. Download the latest release from the Package Registry ("Packages and registries" > "Package Registry") - 1. It should be called something like this: "lilJudd-X.X.X-xxxxxxxx-prod.jar" (replace "X.X.X" with the latest - version and xxxxxxxx" with the commit its based on.) - 2. If you want to run an early version, which may be (very) unsable, you can run a development version. Just use an - entry ending in "-dev.jar" +1. Download the latest release from the Releases page. 2. Place it anywhere you want. 3. Run the following command: - > java -jar lilJudd-X.X.X-xxxxxxxx-prod.jar + > java -jar lilJudd.jar 4. The bot should start and create a config file named "credentials.nils" in a folder called "data" 5. Open it and put in your credentials. 1. token: your Discord bot token 2. dbDomain: the domain and port of your postgresql database (e.g.: 192.168.178.1:5432) - 3. dbName: the name of your database + 3. dbName: the name of the database 4. dbUser: the username of the database - 5. dbPassword: the password to your user + 5. dbPassword: the password to the db user 6. Rerun the command - > java -jar lilJudd-X.X.X-xxxxxxxx-prod.jar + > java -jar lilJudd.jar 7. The bot should now be up and running. ## How to set up workspace