From 1d9245fb8fc1c5692861ff4321e13743b1557842 Mon Sep 17 00:00:00 2001
From: Alvie Rahman <alvierahman90@gmail.com>
Date: Sat, 21 Aug 2021 03:20:23 +0100
Subject: [PATCH] Update readme.md

---
 readme.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index 2a455db..461f334 100644
--- a/readme.md
+++ b/readme.md
@@ -28,7 +28,18 @@ doing it for me:
 
 1. Run `make install` as root
 
-## Usage
+## Things to Remember Whilst Writing Notes
+
+- notes2web reads the following YAML [frontmatter](https://jekyllrb.com/docs/front-matter/) variable:
+
+        - `author` --- The person(s) who wrote the article
+        - `tags` --- A YAML list of tags which the article relates to - this is used for browsing and also searching
+        - `title` --- The title of the article
+        
+- notes2web indexes [ATX-style headings](https://pandoc.org/MANUAL.html#atx-style-headings) for searching
+- notes2web attempts to display file history through the `git log` command
+
+## CLI Usage
 
 ```
 $ notes2web.py notes_directory