diff --git a/README.md b/README.md index 29c8b21..507d198 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,21 @@

How does Revolution work?

Revolution uses a set of modules to handle various functions, there are two modules included with the repo and builds, these being consoleHelper and example_request_handler. consoleHelper is a required module and as such the framework will not start without it, however example_request_handler can be removed without consequence and is there purely to help with module development.

+

How do modules work?

+

Modules are loaded in at runtime and are completely separate from each other. Each module has a prefix, for example the request handlers have the prefix “handle_console”. These prefixes determine the function of the modules and help the server to function.

+

How to use Revolution.

+

From source

+

git clone https://github.com/tgpethan/Revolution.git +cd Revolution +npm i +node . +

+

From build

+

Download latest build (https://github.com/tgpethan/Revolution/releases/latest) +Unzip the zip +Run revolution executable +

+

How to install modules.

+

With modules you simply have to place the module inside the modules folder and start the server. +The modules will automatically set themselves up and the server will start as normal. +

\ No newline at end of file