tgpholly/Revolution
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
the-basic-geek 2020-01-03 04:15:45 +00:00
parent 29d5719cf9
commit a5e6b50662
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -10,3 +10,21 @@
</p>
<h2 align="left">How does Revolution work?</h2>
<p align="left">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.</p>
<h2 align="left">How do modules work?</h2>
<p align="left">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.</p>
<h2 align="left">How to use Revolution.</h2>
<h3 align="left">From source</h3>
<p align="left">git clone https://github.com/tgpethan/Revolution.git
cd Revolution
npm i
node .
</p>
<h3 align="left">From build</h3>
<p align="left">Download latest build (https://github.com/tgpethan/Revolution/releases/latest)
Unzip the zip
Run revolution executable
</p>
<h2 align="left">How to install modules.</h2>
<p align="left">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.
</p>