From 006d2691fd6d823f2efec804648a19de590dee36 Mon Sep 17 00:00:00 2001
From: carpetscheme <joshand@protonmail.com>
Date: Mon, 13 Apr 2020 23:12:39 +0200
Subject: [PATCH] Improving readme for theme

---
 README.md  | 49 +++++++++++++++++++++++++++++++++++++++++++++----
 theme.toml |  9 +++++++++
 2 files changed, 54 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index fe43c27..59efedb 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,9 @@ Demo: [quirky-perlman-34d0da.netlify.com](https://quirky-perlman-34d0da.netlify.
 
 - [Installation](#installation)
 - [Options](#options)
+  - [Title](#title)
+  - [Sass](#Sass)
+  - [RSS](#RSS)
   - [Footer menu](#footer-menu)
 - [Original](#original)
 - [License](#license)
@@ -38,10 +41,49 @@ Posts should be placed in the `blog` folder.
 
 ## Options
 
-### footer-menu
+### Title
+Set a tile and description for your site to appear in the header:
+
+```toml
+title = "Different strokes"
+description = "for different folks"
+
+```
+
+### Sass
+
+The theme's css is compiled from sass and the output is imported inline to the header :zap:
+
+You can overide the styles by enabling sass compilation in the config:
+
+```toml
+compile_sass = true
+```
+
+...and placing a replacement `style.scss` file in the sass folder.
+
+### RSS
+Enable rss with the standard zola option:
+
+```toml
+generate_rss = true
+```
+
+...and include your name and email in the feed by setting fields in `extra` with keys `author` and `email`:
+
+```toml
+[extra]
+
+author = "Grant Green"
+email = "grant@green.org"
+```
+
+### Footer-menu
 Set a field in `extra` with a key of `footer_links`:
 
 ```toml
+[extra]
+
 footer_links = [
     {url = "$BASE_URL/about", name = "About"},
     {url = "$BASE_URL/rss.xml", name = "RSS"},
@@ -53,9 +95,8 @@ If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
 site URL.
 
 ## Original
-This template is based on the Jekyll template [Light Speed Jekyll](https://github.com/bradleytaunt/lightspeed) by Bradley Taunt.
+This template is based on the Jekyll template [Light Speed Jekyll](https://github.com/bradleytaunt/lightspeed) by **Bradley Taunt**:
 
-**Bradley Taunt**
 - <https://github.com/bradleytaunt>
 - <https://twitter.com/bradtaunt>
 
@@ -64,5 +105,5 @@ This template is based on the Jekyll template [Light Speed Jekyll](https://githu
 
 Open sourced under the [MIT license](LICENSE.md).
 
-This project is open source except for example articles found in `_posts`.
+This project is open source except for example articles found in `content`.
 
diff --git a/theme.toml b/theme.toml
index afd67e0..6226644 100644
--- a/theme.toml
+++ b/theme.toml
@@ -13,3 +13,12 @@ homepage = "https://github.com/carpetscheme"
 author = "Bradley Taunt"
 homepage = "https://github.com/bradleytaunt"
 repo = "https://github.com/bradleytaunt/lightspeed"
+
+[extra]
+author = ""
+email = ""
+
+footer_links = [
+    {url = "$BASE_URL/about", name = "About"},
+]
+