From 668c9a9259a40e487926ce8675e563d422f00a8f Mon Sep 17 00:00:00 2001 From: Logan Cusano Date: Sun, 11 Dec 2022 21:24:17 -0500 Subject: [PATCH] Updated readme skeletons --- Client/discord-bot/readme.md | 46 ++++++++++++++++++++++++++++++++++++ Client/readme.md | 46 ++++++++++++++++++++++++++++++++++++ Server/readme.md | 46 ++++++++++++++++++++++++++++++++++++ readme.md | 38 ++++++++++------------------- 4 files changed, 150 insertions(+), 26 deletions(-) diff --git a/Client/discord-bot/readme.md b/Client/discord-bot/readme.md index e69de29..d5783c6 100644 --- a/Client/discord-bot/readme.md +++ b/Client/discord-bot/readme.md @@ -0,0 +1,46 @@ +# Discord Radio Bot: Command & Control - Client: Discord Bot (Client) + +--- + +Explanation here + +## Requirements + +--- + +Requirements here (not modules, that will be installed with npm) + + + +## Installation + +--- + +Notes here + +### Installation here +```shell + +``` + + +## Configuration + +--- + +Notes here + +### Configuration here +```shell + +``` + + +## Usage + +--- + +### Usage here +```javascript + +``` \ No newline at end of file diff --git a/Client/readme.md b/Client/readme.md index e69de29..71e88d1 100644 --- a/Client/readme.md +++ b/Client/readme.md @@ -0,0 +1,46 @@ +# Discord Radio Bot: Command & Control - Client + +--- + +Explanation here + +## Requirements + +--- + +Requirements here (not modules, that will be installed with npm) + + + +## Installation + +--- + +Notes here + +### Installation here +```shell + +``` + + +## Configuration + +--- + +Notes here + +### Configuration here +```shell + +``` + + +## Usage + +--- + +### Usage here +```javascript + +``` \ No newline at end of file diff --git a/Server/readme.md b/Server/readme.md index e69de29..405f273 100644 --- a/Server/readme.md +++ b/Server/readme.md @@ -0,0 +1,46 @@ +# Discord Radio Bot: Command & Control - Server + +--- + +Overview here + +## Requirements + +--- + +Requirements here (not modules, that will be installed with npm) + + + +## Installation + +--- + +Notes here + +### Installation here +```shell + +``` + + +## Configuration + +--- + +Notes here + +### Configuration here +```shell + +``` + + +## Usage + +--- + +### Usage here +```javascript + +``` \ No newline at end of file diff --git a/readme.md b/readme.md index 8496b5a..e77d47b 100644 --- a/readme.md +++ b/readme.md @@ -2,45 +2,31 @@ --- -Explanation here +Project overview here -## Requirements +## Requirements Overview --- -Requirements here (not modules, that will be installed with npm) +### Server Requirements +#### Server: Discord Bot Requirements +### Client Requirements +#### Client: Discord Bot Requirements - - -## Installation +## Server --- -Notes here +Explanation and overview here -### Installation here -```shell - -``` - - -## Configuration +## Client --- -Notes here +Explanation and overview here -### Configuration here -```shell - -``` - - -## Usage +## Discord Bot --- -### Usage here -```javascript - -``` \ No newline at end of file +Explanation and overview here \ No newline at end of file