Updated README.md to reflect new changes and new features

README.md

@@ -6,8 +6,37 @@ Depends on https://github.com/xnoe/cpp-utf8/
 
 Available on Gentoo via the Xnoverlay https://github.com/xnoe/Xnoverlay
 
-Hi! This is a super-duper simplistic (and probably awful) system for aiding in developing many-paged websites. Essentially, all you have to do is have the "layout" in a file called `source/_layout.html` and every other `.html` file will be inserted in to where `{{ content }}` resides within said page. It can only replace once!
+# Introduction
 
-Output will be in the `output` folder.
+Templ is a static-site "generator" aimed at aiding the creation of multi-pages sites. It uses a jekyll-esque "Front Matter" for each page. Currently it only performs formatting on `.html` format pages. Markdown support (maybe) soon:tm:.
+
+# Usage
+
+Templ is designed to be fairly simple to use. Place your site's files in the directory called `source`. Files are directories beginning with `_` will be ignored by Templ.
+
+A basic "Front Matter" for a page maybe be:
+```
+---
+layout: default
+title: Hello World
+url: https://example.com
+---
+```
+
+This will cause Templ to use the file `source/_layouts/default.html` for the layout (where `{{ content }}` within that file will be replaced with the page's source) and define the variables `page.title` and `page.url` (accessible via `{{ page.title }}` and `{{ page.url }}`). Templ will also read configurations from the (badly named) `source/_config.yml` file. This isn't (yet) able to store YAML. Just values separated by `: ` (space included).
+
+Templ is usable in some circumstances but still may be sub-par for people lookint for an actual static site generator. It's also *very, very, **very*** slow!
+
+# Using outputted content
+
+Formatted pages will be in the `output` folder, in the same directory that Templ is called from. 
+
+# Known bugs
 
 Not very bug tested! (Aka. don't use for prod!)
+
+Images break it (seems to be an issue with file reading with multiple consecutive `null` bytes? If anyone can send a PR that'd be great!)
+
+Occasionally gets in to an infinite loop if start / end tags for things are done properly, without any sanity check. (^C to escape and check your source files). This shouldn't be too major of a bug but is just a sign of my awful code :( Sorry All.
+
+Still lacks many necessary features that some people would like to have.