Use .Site.BaseURL to generate sidebar "Home" link

[hyde.git] / README.md
diff --git a/README.md b/README.md

index 0ddc6d56f0398565711441eb51b3704db8bba10e..45ee21fa62fc34a52d637d9c9d66d5507497c136 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,17 +8,32 @@ It pairs a prominent sidebar with uncomplicated content.
  
  ## Contents
  
+- [Installation](#installation)
  - [Options](#options)
    - [Sidebar menu](#sidebar-menu)
    - [Sticky sidebar content](#sticky-sidebar-content)
    - [Themes](#themes)
    - [Reverse layout](#reverse-layout)
-- [Development](#development)
+  - [Disqus](#disqus)
  - [Author](#author)
  - [Ported by](#ported-by)
  - [License](#license)
  
  
+## Installation
+
+To install Hyde as your default theme, first install this repository in the `themes/` directory:
+
+    $ cd themes/
+    $ git clone https://github.com/spf13/hyde.git
+
+Second, specify `hyde` as your default theme in the `config.toml` file. Just add the line
+
+    theme = "hyde"
+
+at the top of the file.
+
+
  ## Options
  
  Hyde includes some customizable options, typically applied via classes on the `<body>` element.
@@ -84,12 +99,38 @@ To create your own theme, look to the Themes section of [included CSS file](http
  
  ![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png)
  
-Hyde's page orientation can be reversed with a single class.
+To reverse page orientation, add the `layoutReverse` variable under `params`, like so:
  
-```html
-<body class="layout-reverse">
-  ...
-</body>
+**TOML**
+```toml
+theme = "hyde"
+
+[params]
+  layoutReverse = true
+```
+
+**YAML**
+```yaml
+theme: "hyde"
+
+params:
+  layoutReverse: true
+```
+
+### Disqus
+
+You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to the `params` in your config file.
+
+**TOML**
+```toml
+[params]
+  disqusShortname = "spf13"
+```
+
+**YAML**
+```yaml
+params:
+  disqusShortname: "spf13"
  ```
  
  ## Author