From 528f75aa9c38cdba434440a5e1fc6ec66f53a293 Mon Sep 17 00:00:00 2001 From: Abheek Dhawan Date: Tue, 23 Feb 2021 15:44:39 -0600 Subject: [PATCH] Add info about PDFs to README.md Added the fact that gotenberg needs to be running for PDF round generations to work. Also update the package.json file to a newer version number. --- README.md | 6 ++++++ bot/package.json | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ef9ef60..b18e9d0 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Deploying this bot to your Discord server is relatively simple: you can add it t ## Contributing If you want to make a contribution to this bot, please make a [Pull Request](https://github.com/ADawesomeguy/AwesomeSciBo/pulls) with as much detail as you can. I'll take a look in my free time and see if it's worth adding. If not, I'll let you know what to do to *make* it worth adding! + ## Installation There are two ways to install this on your own server: using npm and cloning this repository. @@ -47,6 +48,11 @@ cd AwesomeSciBo/bot && npm i node roundbot.mjs ``` +## Usage +To get started, run the command `do be helping` to get a list of commands. The more helpful commands will be the ones that generate packets, which are `do be roundgen pdf/html` and `do be roundgen pdf/html dm`. + +> Note: if you plan to use PDF files, you must have `gotenberg` installed and running at `localhost:3136` (or change the `awesomescibo.mjs` script to point to a different location). You can find more info about that [here](https://github.com/thecodingmachine/gotenberg). + ## Notes ### Creating a Discord Application/Bot To create your own application and bot using the [Discord Developer Portal](https://discord.com/developers), go to the previous link and sign in. Then create a new application, and click bots on the left. Configure it to your liking, and then copy the token. diff --git a/bot/package.json b/bot/package.json index 13349dd..b85e2ba 100644 --- a/bot/package.json +++ b/bot/package.json @@ -5,7 +5,7 @@ "node-fetch": "^2.6.1" }, "name": "awscibo", - "version": "0.0.2", + "version": "0.0.3", "main": "awesomescibo.mjs", "bin": { "awscibo": "./awesomescibo.mjs"