update readme and license

master
morph 3 years ago
parent 2b09fc88e0
commit 6cbd464175
  1. 0
      LICENSE.md
  2. 12
      README.md
  3. 2
      theme.toml

@ -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

@ -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"]

Loading…
Cancel
Save