From 75d092f2d7b995d83a4a32ebb6466a3375d23890 Mon Sep 17 00:00:00 2001 From: Fadi Atamny Date: Sun, 3 May 2020 20:07:03 +0300 Subject: [PATCH] updated readmes --- trafficTrackerCog/README.md | 22 +++++++--------------- trafficTrackerCog/info.json | 2 +- welcomeCog/README.md | 4 ---- 3 files changed, 8 insertions(+), 20 deletions(-) diff --git a/trafficTrackerCog/README.md b/trafficTrackerCog/README.md index bfcc802..085ebba 100644 --- a/trafficTrackerCog/README.md +++ b/trafficTrackerCog/README.md @@ -1,6 +1,5 @@ -# WelcomeCog -This is the Kanium community/guild welcome cog. it sends a DM to any new user that joins the Kanium discord with a [message](./data/embedded_message.json), which has been templated in a json format. -Furthermore, this cog allows the ability to monitor discord activity and log it into a specific channel using the specific commands. +# TrafficTrackerCog +This is the Kanium community/guild welcome cog. monitors the server for activity and logs them to a specific channel using the specific commands. # How to use: In order to use our cog you would need to install it onto your instance of [RedBot](https://github.com/Cog-Creators/Red-DiscordBot). @@ -13,24 +12,17 @@ In order to use our cog you would need to install it onto your instance of [RedB ## How to install & load: 1. `[PREFIX]repo add [RepoName] https://github.com/Kanium/KaniumCogs [ActiveBranch (EX: Master)] ` -2. `[PREFIX]cog install [RepoName] welcomeCog` -3. `[PREFIX]load welcomeCog` +2. `[PREFIX]cog install [RepoName] trafficTrackerCog` +3. `[PREFIX]load trafficTrackerCog` ### To update the Cog: -- `[PREFIX]cog uninstall welcomeCog` +- `[PREFIX]cog uninstall trafficTrackerCog` - `[PREFIX]repo update [RepoName]` -- `[PREFIX]cog install [RepoName] welcomeCog` -- `[PREFIX]load welcomeCog` +- `[PREFIX]cog install [RepoName] trafficTrackerCog` +- `[PREFIX]load trafficTrackerCog` ### Commands -- `[PREFIX]welcomepreview` - sends in the chat a preview of the template message -- `[PREFIX]pullmessage` - allows you to pull the latest version of your message without restarting the bot - `[PREFIX]setchannel` - allows you to select a channel in your discord to dump logs to - `[PREFIX]stats` - prints the statistics that the cog has gathered. - `[PREFIX]resetstats` - allows for a hard reset of the stats - `[PREFIX]toggleLogs` - Toggles the logs functionality on or off - -### To modify the sent message: -If you would like to modify the message to your liking, you can either : -- fork the bot. change the [message](./data/embedded_message.json) and [welcome.py](./welcome.py) line 9 to your repo. -- fork the bot. update the [welcome.py](./welcome.py) line 9 to be directed to your message.json file that you like without having it hosted on github with your repo. diff --git a/trafficTrackerCog/info.json b/trafficTrackerCog/info.json index 60ab654..c84f72f 100644 --- a/trafficTrackerCog/info.json +++ b/trafficTrackerCog/info.json @@ -6,7 +6,7 @@ "name": "TrafficTracker", "short": "Tracks daily activity on the server", "description": "Tracks incoming and outgoing member activity on the server with daily resets", - "requirements": ["aiohttp","datetime"], + "requirements": ["datetime"], "tags": [ "Traffic" ] diff --git a/welcomeCog/README.md b/welcomeCog/README.md index bfcc802..ad81d7b 100644 --- a/welcomeCog/README.md +++ b/welcomeCog/README.md @@ -25,10 +25,6 @@ In order to use our cog you would need to install it onto your instance of [RedB ### Commands - `[PREFIX]welcomepreview` - sends in the chat a preview of the template message - `[PREFIX]pullmessage` - allows you to pull the latest version of your message without restarting the bot -- `[PREFIX]setchannel` - allows you to select a channel in your discord to dump logs to -- `[PREFIX]stats` - prints the statistics that the cog has gathered. -- `[PREFIX]resetstats` - allows for a hard reset of the stats -- `[PREFIX]toggleLogs` - Toggles the logs functionality on or off ### To modify the sent message: If you would like to modify the message to your liking, you can either :