From 6cbd46417531a703c69518e50ed2f7186b4e0a84 Mon Sep 17 00:00:00 2001 From: morph Date: Wed, 27 May 2020 02:10:24 +0200 Subject: [PATCH] update readme and license --- LICENSE => LICENSE.md | 0 README.md | 12 ++++++++---- theme.toml | 2 +- 3 files changed, 9 insertions(+), 5 deletions(-) rename LICENSE => LICENSE.md (100%) diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/README.md b/README.md index 6665aed..5cf59db 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ # smol -A minimal Hugo theme that respects your privacy and is easy on your bandwidth. +A minimal, monospaced blogging theme for Hugo that respects your privacy and is easy on your bandwidth. + +A real-life example can be found at https://morph.sh. smol is based on [Blank](https://github.com/Vimux/Blank) created by [Vimux](https://github.com/Vimux). + +![Screenshot](/images/tn.png) + ## Features - No JavaScript - No Google spyware or tracking of any kind -- No other external dependencies +- No other external dependencies, embedded fonts or comment sections - Dark mode support (depending on your OS's setting) ## Installation @@ -25,7 +30,7 @@ Next, open `config.toml` in the base of the Hugo site and ensure the theme optio theme = "smol" ``` -Lastly, add the following lines to your `config.toml` to make use of all the menu entries in the header and the footer if you need them. +Lastly, add the following lines to your `config.toml` to make use of all the menu entries in the header and footer sections if you need them. ``` # Header @@ -66,7 +71,6 @@ Lastly, add the following lines to your `config.toml` to make use of all the men ``` - For more information read the official [quick start guide](https://gohugo.io/getting-started/quick-start/) of Hugo. ## Contributing diff --git a/theme.toml b/theme.toml index 9841c69..318f26c 100644 --- a/theme.toml +++ b/theme.toml @@ -1,6 +1,6 @@ name = "smol" license = "MIT" -licenselink = "https://github.com/colorchestra/smol/blob/master/LICENSE" +licenselink = "https://github.com/colorchestra/smol/blob/master/LICENSE.md" description = "Minimal Hugo theme using a Monospace font and without any tracking or external dependencies." homepage = "https://github.com/colorchestra/smol" tags = ["blog", "minimal", "monospace", "dark mode", "simple", "clean", "light", "responsive", "fast", "no-js", "no-tracking", "privacy"]