summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 12 insertions, 9 deletions
diff --git a/README.md b/README.md
index a3cffbc..1463347 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,34 @@
-# Blank
+# smol
-Blank — starter [Hugo](https://gohugo.io/) theme for developers. Use it to make your own theme.
+A minimal Hugo theme based on [Blank](https://github.com/Vimux/Blank) using a Monospace font and not much else.
-[Live Demo](https://themes.gohugo.io/theme/blank/)
+## Features
-![Blank theme screenshot](https://github.com/Vimux/blank/blob/master/images/splash.png)
+- No JavaScript
+- No Google spyware or tracking of any kind
+- No other external dependencies
+- Dark mode support (depending on your OS's setting)
## Installation
In your Hugo site `themes` directory, run:
```
-git clone https://github.com/vimux/blank
+git clone https://github.com/colorchestra/smol
```
-Next, open `config.toml` in the base of the Hugo site and ensure the theme option is set to `blank`.
+Next, open `config.toml` in the base of the Hugo site and ensure the theme option is set to `smol`.
```
-theme = "blank"
+theme = "smol"
```
For more information read the official [quick start guide](https://gohugo.io/getting-started/quick-start/) of Hugo.
## Contributing
-Have you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/Vimux/blank/issues) to let me know. Or make directly a [pull request](https://github.com/Vimux/blank/pulls).
+Have you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/colorchestra/smol/issues) to let me know. Or make directly a [pull request](https://github.com/colorchestra/smol/pulls).
## License
-This theme is released under the [MIT license](https://github.com/Vimux/blank/blob/master/LICENSE).
+This theme is released under the [MIT license](https://github.com/colorchestra/smol/blob/master/LICENSE).