Merge pull request #19 from tgpethan/fix-readme

Fix mistakes in readme
This commit is contained in:
the-basic-geek 2020-03-26 16:21:13 +00:00 committed by GitHub
commit 904370fcf4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,7 +2,7 @@
<img height="150" src="http://ethanus.ml/images/Revolution.png"> <img height="150" src="http://ethanus.ml/images/Revolution.png">
</h1> </h1>
<h2 align="left">What is Revolution?</h2> <h2 align="left">What is Revolution?</h2>
<p align="left">Revolution is A modular Web framework, written in node.js , and built with the purpose of being a solid framework that apps can build upon to get up and running quickly and easily. Revolution is designed to make it easy to create the application you need, with no waste. <p align="left">Revolution is a modular web framework, written in node.js and built with the purpose of being a solid framework that apps can build upon to get up and running quickly and easily. Revolution is designed to make it easy to create the application you need, with no waste.
</p> </p>
<h2 align="left">What is Revolution for?</h2> <h2 align="left">What is Revolution for?</h2>
@ -10,7 +10,7 @@
<h2 align="left">How does Revolution work?</h2> <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> <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> <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> <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_requests” and the consoleHelper has the prefix of "handle_console". These prefixes help the server to determine the function of each module.</p>
<h2 align="left">How to use Revolution.</h2> <h2 align="left">How to use Revolution.</h2>
<h3 align="left">From source</h3> <h3 align="left">From source</h3>
<p align="left">git clone https://github.com/tgpethan/Revolution.git<br> <p align="left">git clone https://github.com/tgpethan/Revolution.git<br>