Documentation

README.md

@@ -9,11 +9,13 @@ beautiful and featureful blogging frontend, this isn't for you.<br/>
 
 See the software in action: [deadvey.com](https://deadvey.com)<br/>
 
+# Installation and Running:
+Read the [installation guide](/docs/INSTALLATION.md)
 
-# Confiuration
+# Confiuration:
 Read the [configuation guide](docs/CONFIG.md) for configuration help (in config.json)
 
-# Features
+# Features:
 * post creation, modification and deletion via frontend
 * user creation, modification and deletion via frontend
 * multi user
@@ -25,11 +27,11 @@ Read the [configuation guide](docs/CONFIG.md) for configuration help (in config.
 * site wide custom CSS
 * Page indexes
 
-# Bugs
+# Bugs:
 * probably scales like shit
 * probably insecure as hell
 
-# Planned features/todo list
+# Planned features/todo list:
 * federation (looks tricky)
 * All strings (including in edit and post page) customisable
     * formatable custom strings
@@ -40,9 +42,9 @@ Read the [configuation guide](docs/CONFIG.md) for configuration help (in config.
 * Make EJS modification more user friendly
 * API for returning posts, users, comments, tags other?...
 
-# Docs
+# Docs:
 See [docs/DOCUMENTATION.md](docs/DOCUMENTATION.md)
 
-# Customisation
+# Customisation:
 Customisation of settings can be done via the config.json file (use example-config.json as an example) and see [the configuration guide](docs/CONFIG.md)<br/>
 Additionaly, more complex configuration of the precise template of the whole site, can be done via [EJS](https://ejs.co/) (in /views) (see [the list of things variables and functions available in EJS](docs/EJS.md) (you will need to understand EJS syntax and JavaScript, to customise this (why did I use EJS? well I originally had this weird system of format indicators with percent (%) signs and stuff (like in unix's date (`date`)) but then I was told EJS is better and it sure is, though it is a bit harder to understand but MUCH more powerful!))