Switch to Hugo's built-in Disqus template

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

index 0235f169cfab9e4b1a698be3d65d5405568ccfb3..41f2d5e4328a143a957fd8cbe23b394dcbf022d1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
  # Hyde
  
-Hyde is a brazen two-column [hugo](http://hugo.spf13.com) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name.
+Hyde is a brazen two-column [hugo](https://gohugo.io) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name.
  It pairs a prominent sidebar with uncomplicated content.
  
  ![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png)
@@ -8,6 +8,7 @@ It pairs a prominent sidebar with uncomplicated content.
  
  ## Contents
  
+- [Installation](#installation)
  - [Options](#options)
    - [Sidebar menu](#sidebar-menu)
    - [Sticky sidebar content](#sticky-sidebar-content)
@@ -19,6 +20,20 @@ It pairs a prominent sidebar with uncomplicated content.
  - [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.
@@ -104,19 +119,14 @@ params:
  
  ### 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.
+You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to  your config file.
  
  **TOML**
  ```toml
-[params]
-  disqusShortname = "spf13"
+disqusShortname = "spf13"
  ```
  
-**YAML**
-```yaml
-params:
-  disqusShortname: "spf13"
-```
+> **Note:** Previous version 1.0 the Disqus shortname had to be defined inside the `[params]` block.
  
  ## Author
  **Mark Otto**