[TEM #2] - Update README.md

README.md

@@ -86,55 +86,61 @@ The format is as follows
 3. Any arguments that should be substituted within the template file. Arguments should be seperated by whitespace and
    should be in the `key=value` format.
 
-Arguments to be replaced within the template files should be wrapped in `{}`
+### Arguments
+
+Arguments to be replaced within the template files should be wrapped in `{{$ ...}}`
+
+### Default Values
+
+
 
 ## Valid Configurations
 
-```markdown
+### Template
-# Valid
 
+```markdown
 {{#template file.txt path=../images author=Goudham}}
+```
 
-# Valid
+```markdown
-
 {{#template
     file.txt
     path=../images
     author=Goudham
 }}
+```
 
-# Valid
+```markdown
-
+// _Not recommended but valid_
-// Not recommended but valid
 {{#template     file.txt   path=../images author=Goudham}}
+```
 
-# Valid
+```markdown
-
+// _Not recommended but valid_
-// Not recommended but valid
 {{#template
 file.txt
         path=../images
     author=Goudham
 }}
+```
 
-# Invalid
+### Arguments
-
-// Use {{#include}} for simply including files
-{{#template file.txt}}
 
-# Invalid
+```markdown
+\[[#escaped]]
+```
 
-{{#template
+```markdown
-    file.txt
+[[#width]]
-    path=../images
+```
-    author=Goudham}}
 
-# Invalid
+```markdown
+[[#width 200px]]
+```
 
-{{#template file.txt
+```markdown
-    path=../images
+// _Not recommended but valid_
-    author=Goudham
+[[   #width   400px   ]]
-}}
 ```
 
 ## Example
@@ -161,9 +167,9 @@ and the following content
 `templates/footer.md`
 
 ```markdown
--- Designed By {authors} --
+-- Designed By [[#authors]] --
-![ferris]({path}/ferris.png)
+![ferris]([[#path]]/ferris.png)
-![corro]({path}/corro.png)
+![corro]([[#path]]/corro.png)
 ```
 
 `rust.md`
@@ -241,6 +247,10 @@ Some Content...
 
 Further examples are included within the [examples](/examples) directory which demonstrate a variety of usages.
 
+## GitHub Actions
+
+TODO
+
 ## License
 
 [MIT License](LICENSE)