Pull request?

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Setting up neo
+
+## Standard
+1. [First install minimum Python 3.10](https://www.python.org/downloads/)
+2. Clone the project
+3. Run: `python -m pip install --editable .[dev]` for the development environment.
+Use `.` instead of `.[dev]` for production. 
+4. Setup your bot token in `settings/.env` with key `TOKEN=`
+5. Run `python main.py`
+
+## Docker
+1. [This guide is under the presumption you have Docker installed.](https://docs.docker.com/get-docker/)
+2. Setup `.env` file inside `settings/` folder with key value `TOKEN=XXX`
+3. It is heavily suggested to use `compose v2` which can be [installed from official Docker documentation](https://docs.docker.com/compose/cli-command/)
+4. Run the following command: `docker build -t "neo:latest" .` to build the image `neo:latest`
+5. Using `v2 compose` to run the bot: `docker compose up` in the same location as `docker-compose.yml`
+
+# Contributing
+If you're having trouble with setting up the project, you can find us on the official [Discord](https://discord.gg/zFBfXDY7RY)
+
+You might be wondering why I'm using 3.10 as a requirement when I'm not using anything reliant on 3.10. I plan to implement features from 3.10 specifically in the future, so I'm proofing it for now.
+
+## Submitting a pull request
+If you've decided to fix a bug, even something as small as a single-letter typo, we welcome anything that improves code/documentation for all future users and developers. After all it is a template bot!
+
+If you decide to work on a feature in the issues section it's best to let us (and everyone else) know what you're working on to avoid any duplication of effort. You can do this by replying to the original Issue for the request.
+We can assign and lock it until it's ready if necessary.
+
+When contributing a new example or making a change to a library please keep your code style consistent with ours and latest PEP guidelines.

Dockerfile

@@ -0,0 +1,6 @@
+FROM python:3.10
+COPY . /directory/of/bot
+WORKDIR /same/as/above/dir
+RUN python -m pip install --editable .
+COPY . .
+CMD [ "python", "main.py" ]

README.md

@@ -1,40 +1,37 @@
-<p align="center">
-<img src="https://i.imgur.com/DGLrWwX.png/" height="500" width="500" >
-</p>
+# Description
+- Neo Version: 0.0.5
 
-# Requirements
-Check [requirements.txt](https://github.com/Atomic-Molecule/foxcord/blob/main-(stable)/requirements.txt)
+Neo is a template bot for users wanting a stable bot they can work on and host quickly.
 
+This isn't a full fledged bot with a frontend or anything like that. It's a template bot only, so you will have to create everything else yourself.
 
-# Description
-- Foxcord Version: 0.0.4
+The objective of this bot is to keep the code as dynamic and modular as possible whilst minimising reliability between
+"modules".
 
-Foxcord aims to be beginner-friendly, but will also fall in the category for experienced users. 
+These "modules" are just like anything else, you can edit the states of various things such as enabling/disabling commands or databases
+for example.
 
-The objective of this bot is to keep the code as dynamic and modular as possible whilst minimising reliability between code.
+It's far off any type of standard yet, and a work in progress nonetheless, it's getting there.
 
 Inspiration for this stemmed from the following project: [Sandplate](https://github.com/06000208/sandplate) by [006000208](https://github.com/06000208) - done in JavaScript and a great project. So, I thought why not do one in Python?
 
-This project isn't maintained consistently, it's a hobby project to work on over time.
+I've also worked on [an open source discord bot project](https://github.com/pritam42069/yadps-chan) for a while as it's a fork from here, so I brought some of my optimisations over. Check it out, it's a cool bot.
+
+This project is a hobby project, so there will be inconsistencies.
+
 # Roadmap
  * [x] Create basic dynamic logging system
  * [x] Create bot configuration system
  * [x] Create modular command system
- * [ ] Create docker build images and docker-compose for launching the bot
+ * [x] Create docker build images and docker-compose for launching the bot
  * [x] Create project setup ready for contributions
- * [ ] Realtime interface directly with the bot server sided for elevated backend interaction
+ * [ ] Realtime interface directly with the bot server sided for elevated backend interaction (crying atm)
  * [x] More to be added
 
 # Key features
 - As stated in the description, a very modular system to use and design with
 - Beginner-friendly
 - Useful base features
 
-# Support
-TBD
-
-# Installation & Setup
-TBD
-
-# Contributing
-TBD
+# Contributing, Installation & Setup
+Refer to the [CONTRIBUTING.MD](CONTRIBUTING.md)

docker-compose.yml

@@ -0,0 +1,5 @@
+version: '3.2'
+services:
+ neo:
+   image: neo:latest
+   command: "python /usr/src/app/main.py"