From 1a17c121ca47d4b4becae594512fdf4caa61ba13 Mon Sep 17 00:00:00 2001 From: Qemlokriu Date: Sun, 5 Mar 2023 14:23:26 +0100 Subject: [PATCH] Update 'README.md' --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8bb127c..87ec3c9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ -# example +# example cog -This is a example cog/plugin for mee2 that just say Hello when you type /hello \ No newline at end of file +This is a example cog/plugin for mee2 that just say Hello when you type /hello + +## Installation Guide: + +Prerequisites: mee2, Python 3 + +- Step 1: Download the .py file for the Hello cog from the releases page + +- Step 2: Place the downloaded .py file into the "Cogs" folder located in the root of your mee2 installation + +- Step 3: Open the "config.toml" file and search for the following line: + cogs = ["cogs.web.web"] +If this is your first time, it should look the same. + +Now, add ", 'cogs.example'" to the end of the list so that it looks like this: + cogs = ["cogs.web.web", "cogs.example"] + +That's it! Your Hello cog should now be loaded and ready to use.