From 7bc26becea9e5ec2be7334053be88f7f185e3e30 Mon Sep 17 00:00:00 2001 From: Niklas Buschmann Date: Thu, 18 Jul 2019 21:49:34 +0200 Subject: [PATCH] update README --- README.md | 17 ++++++++++++++--- theme.toml | 4 ++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e7d35ab..11c2518 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,23 @@ -## About - Adaption of the Jekyll version of [contrast](https://github.com/niklasbuschmann/contrast). +## Installation + +To install Hyde as your default theme, first install this repository in the `themes/` directory: + + $ cd themes/ + $ git clone https://github.com/niklasbuschmann/contrast-hugo.git + +Second, specify `contrast-hugo` as your default theme in the `config.toml` file. Just add the line + + theme = "contrast-hugo" + +at the top of the file. + ## Features - supports dark mode on macOS Mojave - MathJax support - - no external ressources + - no external resources - responsive ## Based on diff --git a/theme.toml b/theme.toml index 5731321..826a530 100644 --- a/theme.toml +++ b/theme.toml @@ -3,8 +3,8 @@ license = "MIT" licenselink = "https://github.com/niklasbuschmann/contrast-hugo/blob/master/UNLICENSE.txt" description = "Minimalistic Hugo theme" homepage = "https://github.com/niklasbuschmann/contrast-hugo" -tags = [] -features = [] +tags = ["blog"] +features = ["blog"] min_version = "0.41" [author]