Add section for Sidebar description

spf13 · Aug 30, 2019 · 62d338f · 62d338f
1 parent 6190b66
commit 62d338f
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@ It pairs a prominent sidebar with uncomplicated content.
 - [Installation](#installation)
 - [Options](#options)
   - [Sidebar menu](#sidebar-menu)
+  - [Sidebar description](#sidebar-description)
   - [Sticky sidebar content](#sticky-sidebar-content)
   - [Themes](#themes)
   - [Reverse layout](#reverse-layout)
@@ -77,6 +78,25 @@ Menus:
       URL: "https://www.linkedin.com/in/username/"
 ```
 
+### Sidebar description
+Customise the describe of your page using `description`, like so:
+
+**TOML**
+```toml
+theme = "hyde"
+
+[params]
+  description = "Your custom description"
+```
+
+**YAML**
+```yaml
+theme: "hyde"
+
+params:
+  description = "Your custom description"
+```
+
 
 ### Sticky sidebar content