README.md in askclass-news-theme-0.4.2 vs README.md in askclass-news-theme-0.4.3

@@ -1,8 +1,9 @@
 # AskClass News Theme
+[![Build]][Build Link] [![CodeQL]][CodeQL Link]
 
-Simple responsive Jekyll theme featuring posts and authors.
+Simple responsive Jekyll theme puts posts and authors front and center.
 
 ## Installation
 
 ```sh
 # If starting fresh add this
@@ -13,61 +14,87 @@
 $ bundle
 ```
 
 ## Configuration
 
-Copy these files:
-- `index.html`
-- `config.yml` (edit this to fit your need)
-- `content/` (whole folder as an example)
-- `pwabuilder-sw.js` (PWA)
+Copy these files to your main folder.
+Edit `_config.yml` to your need.
+The `content` folder requires 3 sub-folders.
+`content/_hastags` folder requires `index.html`; copy content of `index.html` for every named tag.
 
-## Post File Format
+```
+/
+│   index.html (required)
+│   404.html
+│   _config.yml (edit this file)
+│   pwabuilder-sw.js (PWA)
+│
+└── content/
+│   │
+│   └── _posts/
+│   │   │   2022-06-15-the-academy.md
+│   │   │   ...
+│   │
+│   └── _writers/
+│   │   │   plato.md
+│   │   │   ...
+│   │
+│   └── _hashtags/
+│   │   │   index.html (required)
+│   │   │   bio.md
+│   │   │   ...
+```
 
+## Post Frontmatter
+
+Field        | Example               | Description
+---          | ---                   | :---
+`layout`     | `post`                | Don't add this unless you know what you're doing
+`title`      | `The Hobbit`          | Main title of the post
+`category`   | `J.R.R._Tolkien`      | Make author clickable (note the `_`)
+`writer`     | `J.R.R. Tolkien`      | Non-clickable writer's name (note no `_`)
+`color`      | `c5`                  | Values: `c1` .. `c10` (see [Card Colors]);
+`tags`       | `fantasy fiction`     | Alphanumeric words, use `-` to connect words
+`image`      | URL                   | Optional main image
+`source`     | `The Tolkien Society` | Optional main source
+`source_url` | URL                   | Optional link to `source`
+
+Example
+
 ```md
 ---
-# Don't change this
-layout: post
-# Well, what else could this be?
-title: The Hobbit
-# This is your author's name
+title: The Hobbit: An Unexpected Party
 category: J.R.R._Tolkien
-# Alternatively
-writer: J.R.R Tolkien
-# Values: c1 .. c10
-color: c1
-# Tags separated by spaces
-tags: fiction fantasy
-# Optional title image (shows up on index)
-image: https://article.images/iamge.jpg
-# Optional source info
-source: The Tolkien Society
-source_url: https://www.tolkiensociety.org/
+color: c5
+tags: fantasy fiction
 ---
 
-Whatever is here goes gets on index.
+In a hole in the ground there lived a hobbit.
 <!--more-->
-The rest of the article.
+Not a nasty, dirty, wet hole, filled with the ends of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to eat: it was a hobbit-hole, and that means comfort.
 ```
 
-## Writer File Format
+## Writer Frontmatter
 
+Field      | Example   | Description
+---        | ---       | :---
+`layout`   | `writer`  | Don't add this unless you know what you're doing
+`size`     | `100`     | Optional profile image size
+`style`    | `center`  | Optional alignment either (`center` or `left`)
+`image`    | URL       | Optional link to profile image
 ```md
 ---
-# Don't change this
-layout: writer
-# Optional size of image
 size: 100
-# Optional position of the profile image either center or left
-style: center
-# Optional image
+style: left
 image: https://author.images/tolkien.jpg
 ---
 
 Biography.
 ```
 
+----
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/beAuthentic/askclass-news-theme.
 This project is intended to be a safe, welcoming space for collaboration, and contributors are
 expected to adhere to the [Contributor Covenant] code of conduct.
@@ -92,5 +119,10 @@
 
 [Manifest Categories]: https://developer.mozilla.org/en-US/docs/Web/Manifest/categories
 [Google Fonts]: https://fonts.google.com/
 [MPL-2.0 License]: https://opensource.org/licenses/MPL-2.0
 [Contributor Covenant]: http://contributor-covenant.org
+[Card Colors]: https://acn.askclass.com/2022/06/18/card-colors
+[Build]: https://github.com/beAuthentic/askclass-news-theme/actions/workflows/gem-push.yml/badge.svg
+[Build Link]: https://github.com/beAuthentic/askclass-news-theme/actions/workflows/gem-push.yml
+[CodeQL]: https://github.com/beAuthentic/askclass-news-theme/actions/workflows/codeql-analysis.yml/badge.svg
+[CodeQL Link]: https://github.com/beAuthentic/askclass-news-theme/actions/workflows/codeql-analysis.yml