Readme updates #9

tgpholly · 2020-01-02T23:33:21Z

littlemisssynth commented

2020-01-02 23:33:21 +00:00

(Migrated from github.com)

Resolves #2

tgpholly requested changes

2020-01-02 23:39:07 +00:00

tgpholly left a comment

Maybe add more before requesting a review?

tgpholly requested changes

2020-01-03 04:28:26 +00:00

tgpholly left a comment

It's mostly ok, just keep it the same as the mockup and place it in codeblocks.

README.md

					
				@ -10,0 +10,4 @@

				<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>