Revamp readme

1 files changed, 46 insertions, 95 deletions

diff --git a/README.md b/README.md
index 37523ee..5b244a1 100644
--- a/README.md
+++ b/README.md
@@ -4,104 +4,76 @@
 
 A minimal hugo theme made with bootstrap that focuses on content readability. 
 
-The typical page size, if the page has no images, is under 100kb. It's even lower if assets are compressed by your web server. The only other assets loaded besides the HTML and the Bootstrap CSS are: 
+## Table of contents
 
-* Favicon (if enabled)
-* Google Analytics JS (if enabled)
-* Cookie Consent CSS/JS (if enabled)
+- [Demo](#demo)
+- [Minimum Hugo version](#minimum-hugo-version)
+- [Installation](#installation)
+- [Updating](#updating)
+- [Run example site](#run-example-site)
+- [Blog post folder](#blog-post-folder)
+- [Configuration](#configuration)
+- [Favicons](#favicons)
+- [Override](#override)
+  - [Homepage example](#homepage-example)
+  - [Configure cookie consent](#configure-cookie-consent)
+- [Syntax highlighting](#syntax-highlighting)
+- [Shortcodes](#shortcodes)
+  - [`blockquote`](#blockquote)
+  - [`imgAbs`](#imgabs)
+  - [`imgRel`](#imgrel)
+  - [`imgProc`](#imgproc)
+- [Getting help](#getting-help)
 
-Demos:
+## Demo
 
-* Dev demo, immediate updates: <https://minimal-bootstrap-hugo-theme.netlify.com/>
-* Hugo Themes demo, weekly-ish updates: <https://themes.gohugo.io/theme/minimal-bootstrap-hugo-theme/>
+https://minimal-bootstrap-hugo-theme.netlify.com/
 
-## Table of Contents
+## Minimum Hugo version
 
-* [Hugo Version](#hugo-version)
-* [Installation Options](#installation-options)
-    * [Add it as a Git Submodule](#add-it-as-a-git-submodule)
-    * [Download a Zip and Unzip it](#download-a-zip-and-unzip-it)
-* [Update Options](#update-options)
-    * [Git Submodule](#git-submodule)
-    * [Zip](#zip)
-* [Example Site Layout](#example-site-layout)
-* [Configuration](#configuration)
-* [Favicon and Apple Touch Icon](#favicon-and-apple-touch-icon)
-* [Override](#override)
-    * [Homepage Example](#homepage-example)
-    * [Configure Cookie Consent](#configure-cookie-consent)
-* [Syntax Highlighting](#syntax-highlighting)
-* [Front Matter Dates](#front-matter-dates)
-    * [publishdate](#publishdate)
-    * [lastmod](#lastmod)
-* [Shortcodes](#shortcodes)
-    * [blockquote](#blockquote)
-    * [imgAbs](#imgabs)
-    * [imgRel](#imgrel)
-    * [imgProc](#imgproc)
-* [Getting Help](#getting-help)
-* [Contribution](#contribution)
+Hugo version `0.48` or higher is required. View the [Hugo releases](https://github.com/gohugoio/hugo/releases) and download the binary for your OS.
 
-## Hugo Version
+## Installation
 
-This theme requires hugo version `0.48` or above. Take a look at the [hugo releases](https://github.com/gohugoio/hugo/releases) and download the hugo binary for your operating system. 
+From the root of your site:
 
-## Installation Options
-
-### Add it as a Git Submodule
-
-1. `cd YOUR_SITE`
-1. `git submodule add https://github.com/zwbetz-gh/minimal-bootstrap-hugo-theme.git themes/minimal-bootstrap-hugo-theme`
-
-### Download a Zip and Unzip it
-
-1. [Download a zip of the theme from GitHub](https://github.com/zwbetz-gh/minimal-bootstrap-hugo-theme/archive/master.zip)
-1. Unzip it into `YOUR_SITE/themes/`
-1. Once unzipped, it will be named `minimal-bootstrap-hugo-theme-master`. Rename it to `minimal-bootstrap-hugo-theme`
+```
+git submodule add https://github.com/zwbetz-gh/minimal-bootstrap-hugo-theme.git themes/minimal-bootstrap-hugo-theme
+```
 
-## Update Options
+## Updating
 
-### Git Submodule
+From the root of your site:
 
-If you used the git submodule option to install the theme, update it by running:
+```
+git submodule update --remote --merge
+```
 
-1. `cd YOUR_SITE`
-1. `git submodule update --remote --merge`
+## Run example site
 
-### Zip
+From the root of `themes/cupper-hugo-theme/exampleSite`:
 
-If you downloaded a zip to install the theme, just do those installation steps again to update it.
+```
+hugo server --themesDir ../..
+```
 
-## Example Site Layout
+## Blog post folder
 
 This theme expects your _posts_ to be under the `post` folder. 
 
 If you want to use a different folder, then override the [`post-list.html`](https://github.com/zwbetz-gh/minimal-bootstrap-hugo-theme/blob/master/layouts/partials/post-list.html) partial and replace `post` with the name of your folder. 
 
-```
-│   config.toml
-├───content/
-│   │   about.md
-│   └───post/
-│           creating-a-new-theme.md
-│           goisforlovers.md
-│           hugoisforlovers.md
-│           migrate-from-jekyll.md
-```
-
 ## Configuration
 
 Copy the `config.toml` from the [`exampleSite`](https://github.com/zwbetz-gh/minimal-bootstrap-hugo-theme/tree/master/exampleSite), then edit as desired. 
 
-## Favicon and Apple Touch Icon
-
-Place your `favicon.ico` and `apple-touch-icon.png` files at the root of your site, i.e. place them directly under `YOUR_SITE/static/`. See `exampleSite/static/` for other (optional) favicon files.
+## Favicons
 
-To generate all these favicons from a single image, use the [RealFaviconGenerator](https://realfavicongenerator.net/) online tool. After using the tool, you'll be prompted to download a zip of your favicon package. You'll then want to extract the zip contents directly into `YOUR_SITE/static/`. 
+Upload your image to [RealFaviconGenerator](https://realfavicongenerator.net/) then copy-paste the generated favicon files under `static`. 
 
 ## Override
 
-### Homepage Example
+### Homepage example
 
 As an example, let's say you didn't like the default homepage, and wanted to design one of your own. To do this, you would:
 
@@ -109,7 +81,7 @@ As an example, let's say you didn't like the default homepage, and wanted to des
 1. Paste that file to `YOUR_SITE/layouts/index.html`
 1. Edit `index.html` as desired
 
-### Configure Cookie Consent
+### Configure cookie consent
 
 You can change the position, layout, color palette, "Learn more" link, compliance type, and custom text of the cookie consent popup. To do this, you would:
 
@@ -118,13 +90,12 @@ You can change the position, layout, color palette, "Learn more" link, complianc
 1. Complete the [cookie consent wizard](https://cookieconsent.insites.com/download/)
 1. Paste the generated code from the wizard into `cookie-consent.html`
 
-## Syntax Highlighting
+## Syntax highlighting
 
 Hugo has built-in syntax highlighting, provided by Chroma. To use it, add these lines to your `config.toml` right after the `theme` line:
 
 ```
 pygmentsCodefences = true
-pygmentsCodefencesGuessSyntax = true
 pygmentsStyle = "pygments"
 ```
 
@@ -132,20 +103,6 @@ Here, `"pygments"` is just the name of the Chroma style to be used. Checkout the
 
 For a deeper dive see the [hugo docs for syntax highlighting](https://gohugo.io/content-management/syntax-highlighting/).
 
-## Front Matter Dates
-
-### `publishdate`
-
-If you don't set `publishdate` in your front matter, it will fallback to `date`. 
-
-### `lastmod`
-
-If you have `enableGitInfo = true` in your `config.toml`, then `lastmod` date will be git's last revision of the file.
-
-If you have `enableGitInfo = false` (or don't have that line at all) in your `config.toml`, then `lastmod` date will be the `lastmod` value in your front matter. If you don't have `lastmod` in your front matter, it will fallback to `date`. 
-
-For a deeper dive see the [hugo docs for configure dates](https://gohugo.io/getting-started/configuration/#configure-dates). 
-
 ## Shortcodes
 
 ### `blockquote`
@@ -206,12 +163,6 @@ class="some-class"
 style="some-style" >}}
 ```
 
-## Getting Help
-
-If you run into an issue that isn't answered by this documentation, then head over to the [hugo discussion forum](https://discourse.gohugo.io/). The folks there are quite helpful and friendly. 
-
-**Before** asking your question, be sure to read the [requesting help guidelines](https://discourse.gohugo.io/t/requesting-help/9132). 
-
-## Contribution
+## Getting help
 
-Pull requests, issues, and general feedback are welcomed.
+If you run into an issue that isn't answered by this documentation or the [`exampleSite`](https://github.com/zwbetz-gh/minimal-bootstrap-hugo-theme/tree/master/exampleSite), then visit the [Hugo forum](https://discourse.gohugo.io/). The folks there are helpful and friendly. **Before** asking your question, be sure to read the [requesting help guidelines](https://discourse.gohugo.io/t/requesting-help/9132). Feel free to tag me in your question, my forum username is [@zwbetz](https://discourse.gohugo.io/u/zwbetz/summary).