From 74d5f60ad6252149576b971b34a16f0b5dc2760b Mon Sep 17 00:00:00 2001
From: Ethan Wong <87055387+ethanwongca@users.noreply.github.com>
Date: Mon, 12 Aug 2024 17:40:55 -0700
Subject: [PATCH] Updating ReadME to match current README skills
---
README.md | 101 +++++++++++++++++++++++++++++++++++++++---------------
1 file changed, 74 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index b934439..7522bb9 100644
--- a/README.md
+++ b/README.md
@@ -1,47 +1,94 @@
-
+# Canadian Online Model United Nations (COMUN)
-This is the technical portion for Canadian Online Model United Nations, a 2 x Special Mention for the United Nations
-High Commissioner for Refugees MUN Refugee Challenge and one of the first virtual and free Model United Nations.
-This Model United Nations has amassed over 300 delegates from 37 countries to attend.
+
- Awards from UNHCR are placed in the awards folder.
+Welcome to the technical repository for the **Canadian Online Model United Nations** (COMUN). COMUN is one of the first virtual and free Model United Nations, recognized with **2 x Special Mentions** from the **United Nations High Commissioner for Refugees (UNHCR)** MUN Refugee Challenge. We have successfully hosted over **300 delegates** from **37 countries** worldwide.
- Letters for COMUN are placed in the COMUN letters folder.
+📂 **Awards**: UNHCR awards can be found in the [**awards folder**](./awards).
+📂 **Letters**: COMUN-related letters are available in the [**COMUN letters folder**](./COMUN-letters).
- Languages and Libraries
- For the bots - Python 3, discord library, asyncio, nest_asyncio, and time library
+---
- For the website - Javascript, CSS, HTML
+## 🌐 Connect with Us
+[](https://www.linkedin.com/company/canadianonlinemun)
+[](https://www.instagram.com/canadianonlinemun/?hl=en)
- Discord Bots
+---
-Bot code are in the bots folder. Examples of each bot are below
+## 📋 Table of Contents
- Welcome Bot - This bot greets delegates when they enter the COMUN server.
-
+- [Languages and Libraries](#-languages-and-libraries)
+- [Discord Bots](#-discord-bots)
+- [Website](#-website)
+- [Usage](#-usage)
- Poll Bot - Creates a poll for voting between three options, abstaining, for, and against and counts up the poll.
-
+---
- Roll Call Bot - Asks delegates their status, present or present and voting, then stores the delegate's choice.
-
+## 🛠 Languages and Libraries
- TImer Bot - Creates a timer that counts down with the /time 60 command. Then countdown in real-time.
-
+### **Bots:**
- Role Bot - After /strong command, then roles (committees delegates are in) will be administered via emojis.
-
-
+- **[Python 3](https://www.python.org/doc/)**: The primary programming language used for developing the bots due to its simplicity and extensive libraries.
+- **[Discord.py (v1.7.3)](https://discordpy.readthedocs.io/en/stable/)**: A Python library used for interacting with the Discord API. It provides an easy way to create bots that can communicate with users on Discord servers.
+- **[Asyncio](https://docs.python.org/3/library/asyncio.html)**: Used for writing concurrent code with the async/await syntax. It is essential for handling multiple tasks, such as processing user commands and responding to them in real-time.
+- **[Nest_asyncio](https://github.com/erdewit/nest_asyncio)**: A small Python library that allows asyncio to be used in environments that have an already running asyncio event loop (like Jupyter notebooks).
+- **[Time](https://docs.python.org/3/library/time.html)**: A standard Python library for manipulating time-related tasks like setting timers, measuring execution time, and delaying actions.
+### **Website:**
+- **[JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide)**: Used for adding interactivity to the website, including button transitions and dynamic content updates.
+- **[CSS](https://developer.mozilla.org/en-US/docs/Web/CSS)**: Used for styling the website to create a visually appealing and responsive design.
+- **[HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)**: The backbone of the website, used for structuring the content and elements.
- Website
+---
-For the website, I kept it quite simple; I used essential website elements from javascript, HTML, and CSS. The final result is below. One fun feature is the button transition into a white button, and each social media button is anchored to COMUN's socials.
+## 🤖 Discord Bots
-The website's code is in the web folder
+The bot code can be found in the [**bots folder**](./bots). Below are examples of each bot in action:
-The GitHub page is this link as well https://ethanwongca.github.io/canadianonlinemun/
+### **Welcome Bot**
+Greets delegates when they enter the COMUN server.
-
+
+
+### **Poll Bot**
+Creates a poll for voting between three options: abstain, for, and against, and counts up the poll results.
+
+
+
+### **Roll Call Bot**
+Asks delegates their status (present or present and voting) and stores the delegate's choice.
+
+
+
+### **Timer Bot**
+Creates a countdown timer with the `/time 60` command.
+
+
+
+### **Role Bot**
+Assigns roles (committees delegates are in) via emojis after a specific command.
+
+
+
+
+---
+
+## 🌐 Website
+
+The website was designed with simplicity in mind using **JavaScript**, **HTML**, and **CSS**. It features interactive elements like button transitions and anchored social media buttons. The website's source code is located in the [**docs folder**](./docs).
+
+### **GitHub Page**:
+Check out the live version of the website [**here**](https://ethanwongca.github.io/canadianonlinemun/).
+
+
+
+---
+
+## 💻 Usage
+
+1. **Clone the repository**:
+ ```bash
+ git clone https://github.com/ethanwongca/canadianonlinemun.git
+ cd canadianonlinemun