Update README.md

This commit is contained in:
Ethan Stubbs 2020-06-15 13:54:19 +01:00 committed by GitHub
parent d3813d5932
commit 178b43928c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -11,7 +11,7 @@ Revolution is a modular web server, written in node.js and was built with my web
## What is Revolution for? ## What is Revolution for?
Basically anything web related. As long as you want to try it, its probably possible. Basically anything web related. As long as you want to try it, its probably possible.
## How does Revolution work? ## 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 server will not start without it, however example_request_handler can be removed without consequence and is there purely to help with module development. 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 server will not start without it although nothing is stopping you from making your own module with the module identifier of **handle_console**, however example_request_handler can be removed without consequence and is there purely to help with module development.
## How do modules work? ## 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_requests” and the consoleHelper has the prefix of "handle_console". These prefixes help the server to determine the function of each module. 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_requests” and the consoleHelper has the prefix of "handle_console". These prefixes help the server to determine the function of each module.
## How to use Revolution. ## How to use Revolution.