From e6e5c176e7f8e06710b9e447c2644725ab828f87 Mon Sep 17 00:00:00 2001 From: David Gomes Date: Thu, 6 Jan 2022 19:59:47 +0000 Subject: [PATCH 1/5] Added configuration to README.md --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a2d872d..fe32ad0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ +# Required configuration + +You need to create an `application.yaml` file, with the following fields filled: +``` +discord: + bot-token: + webhook: + id: + token: + channel-id: + app-id: +``` +Then place it inside a `config` folder. + # Building -Run `mvn quarkusBuild`, then copy the `build/quarkus-app` contents to the desired folder. +Run `gradle quarkusBuild`, then copy the `build/quarkus-app` contents to the desired folder. + +# Running + +In dev, run `gradle quarkusDev`. + +Otherwise, if it's already built, just run `java -jar quarkus-run.jar`. + +Note: remember to have `config/application.yaml` in the folder you're running. + +# Further configuration + +## Quotes source + +The bot has 2 possible sources it gets the quotes from, [goodreads](https://goodreads.com)(default) and [Pensador](https://www.pensador.com). + +You can choose which one by specifying the `source` in the yaml. (`goodreads` or `pensador`) + +## Period + +To change when it runs, it's specified in the yaml as `cron-expr`. (the Quarkus scheduler uses the [quartz format](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) by default) From 7c75a1ed3c453928fa0e7868f625e271701b44c9 Mon Sep 17 00:00:00 2001 From: David Gomes Date: Thu, 6 Jan 2022 20:00:59 +0000 Subject: [PATCH 2/5] Update README.md --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fe32ad0..816e1ba 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# Required configuration +# Pensador + +"Just another Discord bot, this one sends random quotes :)" sums it up. + +## Required configuration You need to create an `application.yaml` file, with the following fields filled: ``` @@ -12,11 +16,11 @@ discord: ``` Then place it inside a `config` folder. -# Building +## Building Run `gradle quarkusBuild`, then copy the `build/quarkus-app` contents to the desired folder. -# Running +## Running In dev, run `gradle quarkusDev`. @@ -24,14 +28,14 @@ Otherwise, if it's already built, just run `java -jar quarkus-run.jar`. Note: remember to have `config/application.yaml` in the folder you're running. -# Further configuration +## Further configuration -## Quotes source +### Quotes source The bot has 2 possible sources it gets the quotes from, [goodreads](https://goodreads.com)(default) and [Pensador](https://www.pensador.com). You can choose which one by specifying the `source` in the yaml. (`goodreads` or `pensador`) -## Period +### Period To change when it runs, it's specified in the yaml as `cron-expr`. (the Quarkus scheduler uses the [quartz format](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) by default) From b46e0199280a6027d32ccd89ff75df8d03b41270 Mon Sep 17 00:00:00 2001 From: David Gomes Date: Thu, 6 Jan 2022 20:02:44 +0000 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 816e1ba..0467f7e 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Note: remember to have `config/application.yaml` in the folder you're running. ### Quotes source -The bot has 2 possible sources it gets the quotes from, [goodreads](https://goodreads.com)(default) and [Pensador](https://www.pensador.com). +The bot has 2 possible sources it gets the quotes from, [goodreads](https://goodreads.com) (default) and [Pensador](https://www.pensador.com). You can choose which one by specifying the `source` in the yaml. (`goodreads` or `pensador`) From 809925602626d6d3547849962716f3356cd6ecdc Mon Sep 17 00:00:00 2001 From: David Gomes Date: Thu, 6 Jan 2022 20:03:12 +0000 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0467f7e..686b863 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Note: remember to have `config/application.yaml` in the folder you're running. ### Quotes source -The bot has 2 possible sources it gets the quotes from, [goodreads](https://goodreads.com) (default) and [Pensador](https://www.pensador.com). +The bot has 2 possible sources it gets the quotes from: [goodreads](https://goodreads.com) (default) and [Pensador](https://www.pensador.com). You can choose which one by specifying the `source` in the yaml. (`goodreads` or `pensador`) From c7c258b16d5740dfba7a51caf68bb8c6e24d1c2b Mon Sep 17 00:00:00 2001 From: David Gomes Date: Thu, 6 Jan 2022 20:54:41 +0000 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 686b863..ee79c9e 100644 --- a/README.md +++ b/README.md @@ -38,4 +38,4 @@ You can choose which one by specifying the `source` in the yaml. (`goodreads` or ### Period -To change when it runs, it's specified in the yaml as `cron-expr`. (the Quarkus scheduler uses the [quartz format](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) by default) +To change how often it runs, specify in the yaml as `cron-expr`. (the Quarkus scheduler uses the [quartz format](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) by default)