Readme Update

2 files changed, 56 insertions, 18 deletions

diff --git a/README.md b/README.md
index f57f846..d6c5179 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ zola serve
 ```
 
 ## Installation
-The Quick Start example shows you how to run the theme directly as a site.
+The Quick Start shows how to run the theme directly as a site.
 Next we will use abridge as a theme to a NEW site.
 
 ### Step 1: Create a new zola site
@@ -64,6 +64,7 @@ theme = "abridge"
 ```
 
 Or copy the `config.toml` from the theme directory to your project's root directory:
+(This will give you a base configuration with all config values used)
 
 ```bash
 cp themes/abridge/config.toml config.toml
@@ -126,9 +127,16 @@ $mb:1200px !default;// value at which to switch from fluid layout to using max-w
 
 Colors and style are handled by the sass files of [abridge.css](https://github.com/jieiku/abridge.css)
 
-To change colors of this theme all you need to do is edit `/themes/abridge/sass/skins/_auto.scss`
-then in the root of your site type `zola build` which will regenerate your site, this is similar to what zola serve does, except it does not facilitate serving the site.
-This is also the way you should generate your site to serve it by a real webserver such as nginx.
+Abridge comes with two "Skins" each with their own auto, dark, and light modes.
+Auto mode automatically displays a dark or light version depending on browser/OS settings.
+
+The skin used on [the Demo](https://jieiku.github.io/abridge-demo/) uses primarily orange colors.
+It is defined here: `/themes/abridge/sass/abridge.scss` and imports: `/themes/abridge/sass/skins/_abridge-auto.scss`
+
+There is also other variations, that you will see defined in these same directories.
+
+To change colors or fonts all you need to do is edit these files or duplicate them and create your own skin.
+Then in the root of your site type `zola build` which will regenerate your site, this is similar to what zola serve does, except it does not facilitate serving the site.
 
 ### Global Configuration
 
@@ -158,19 +166,49 @@ The default elasticlunr search is currently used, I may eventually switch this o
 
 #### Configuration options under the `extra`
 
+Most Options in the config.toml are self documenting, meaning between the name of the config value and the notes in the file it is usually obvious what an option is for.
+
 The following options should be under the `[extra]` in `config.toml`
 
+- `language_code` - Set the site language_code.
+- `title_separator` - Separator between title and title_addition, eg "|": "Abridge | Fast & Lightweight Zola Theme"
+- `title_addition` - a default value for title addition, used at the index.
+
+- `author` - Used for articles to denote the author.
+- `author_show = true` - Displays the author name on line with date, tags, categories
+- `readtime = true` - Displays the read time on line with date, tags, categories.
+- `readtime_string` - The word following the read time, you can set this to "min", "minutes", "min read", etc.
 - `recent = true` - This enabled the Recent posts box visible on the top right.
 - `recent_items = 9` - The number of items to display in the recent posts box
 - `footer_credit = true` - This enables the powered by zola and abridge line in the footer.
-- `textlogo` - The Text based logo in the top left corner
+- `footer_credit_override` - Can be used to customize the footer credit, useful to add icons to the text, etc.
+
+- `logo = { file="logo.svg", width="42", height="42", alt="Abridge", text="bridge" }` - Defines the graphical logo with optional text to follow the logo.
+- `textlogo` - A purely Text based logo, this will be used if logo is commented out, if both are commented out then config.title is used.
 - `sitedesc` - This add the site description just below the text based logo.
-- `author` - Used for articles to denote the author.
-- `keywords` - This is used for SEO, I am however still working on the SEO related fields, they are likely not 100% correct yet.
-- `banner` - Image to use in seo related cards, this will be the fallback image if the individual articles does not provide one, still a work in progress.
+- `copyright_start_year` - Optionally define a start year for the copyright, otherwise the current year is used.
+- `copyright_end_year` - Optionally set the copyright end year, recommend leaving unset, zola build will set this to current year by default
+- `headhr` - Display a horizontal rule below header
+- `foothr` - Display a horizontal rule above footer
 - `menu` - This is an array of links to display at the top right corner of the page
 - `menu_footer` - This is an array of links to display in the footer of the page
-- `extra.social` - These are the options for the social icons in the footer, and a couple are also used in SEO related meta tags, still a work in progress.
+
+- `security_header_referrer` - This is mostly used for tracking, the default is set to "strict-origin-when-cross-origin" [info](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)
+- `security_header_csp` - Content Security policy, to enfore security rules: [observatory](https://observatory.mozilla.org) [csp-google](https://csp-evaluator.withgoogle.com/)
+
+- `banner` - Image to use in seo related cards, this will be the fallback image if the individual articles does not provide one, still a work in progress.
+- `js_search_index = "search_index.en.js"` - The search index file to include in the header, comment out to disable.
+- `js_search = "search.min.js"` - The search script file to include in the header, comment out to disable.
+- `rss_atom_feed = "atom.xml"` - The atom.xml rss file to include in the header.
+- `stylesheet = "abridge.css"` - The stylesheet file to include in the header.
+- `fontawesome =` - Uncomment to enable fontawesome library, this will include the file in the header.
+- `fonts =` - Uncomment to load external fonts, they will be loaded in the header.
+- `math` - Set to true to load the Katex library, enabling the use of the [katex shortcode](https://jieiku.github.io/abridge-demo/overview-math/)
+- `math_auto_render` - This allows you to define a section of math notation using only $$ $$ symbols instead of using the katex shortcode directly.
+
+- `keywords =` - This is used for SEO.
+- `seo =` - This is used for SEO, for the social media related tags, eg: opengraph, facebook, twitter if set to false it disables them all.
+- `extra.social` - These are the options for the social icons in the footer, and a couple are also used in SEO related meta tags.
 
 Additionally you should configure which social icons you plan to use. (makes the css file size smaller)
 
@@ -217,28 +255,28 @@ menu_footer = [
 
 ### SEO and Header Tags
 
-Some SEO Tags have been added as well as some important head tags for browser compatibility.
+Most SEO Tags have been added as well as some important head tags for browser compatibility.
 
-you can review them in the head section of templates/base.html, all configurable values should be in config.toml under config.extra
+you can review them in the head section of `templates/macros/head.html`, all configurable values should be in config.toml under config.extra
 
 SEO is still a work in progress, will be performing more testing and updates as time allows.
 
 ### Templates
 
-All pages are extend to the `base.html`, and you can customize them as need.
+All pages extend to `base.html`, and you can customize them as need.
 
 ## Reporting Issues
 
-We use GitHub Issues as the official bug tracker for **abridge**. Please
-search [existing issues](https://github.com/jieiku/abridge/issues). It’s
-possible someone has already reported the same problem.
-
+We use GitHub Issues as the official bug tracker for **abridge**.
+Please search [existing issues](https://github.com/jieiku/abridge/issues).
+It’s possible someone has already reported the same problem.
 If your problem or idea is not addressed yet, [open a new issue](https://github.com/jieiku/abridge/issues/new).
 
 ## Contributing
 
 We'd love your help! Especially with fixes to issues.
 The overall idea behind abridge is to be lightweight and fast, and to use zero javascript other than the search.
+If javascript is an absolute requirement for a feature to work then it may be added as disabled by default.
 
 ## License
 
diff --git a/config.toml b/config.toml
index 287a006..b1ee8e4 100644
--- a/config.toml
+++ b/config.toml
@@ -55,9 +55,9 @@ textlogo = '<font color="#f90">A</font>bridge'
 sitedesc = false # enables or disables the display of the site description below the logo.
 #copyright_start_year = 2019  # optional
 #copyright_end_year = 2020  # optional, recommend leaving unset, zola build will set this to current year by default
-
 headhr = false # show or hide horizontal rule below header
 foothr = true # show or hide horizontal rule above footer
+
 menu = [
     {url = "/", name = "Home", slash = true},
     {url = "/about/", name = "About", slash = true},
@@ -87,7 +87,7 @@ security_header_referrer = "strict-origin-when-cross-origin"
 # Resource Files
 #################
 banner = "banner.png" # Used as default image for OpenGraph/Twitter if page specific image is undefined.
-js_search_index ="search_index.en.js"
+js_search_index = "search_index.en.js"
 js_search = "search.min.js"
 rss_atom_feed = "atom.xml"
 stylesheet = "abridge.css" # location and file to use for stylesheet: