Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/thegeeklab/hugo-geekdoc.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Kaussow <mail@geeklabor.de>2020-01-15 01:00:23 +0300
committerRobert Kaussow <mail@geeklabor.de>2020-01-15 01:00:23 +0300
commita941caf70cf7028357b7bb5ab0e21d29af38cac3 (patch)
tree4bba909f688ec05f2ab6cc5e15a5f2c0ea183885 /README.md
parent05dd03396ccea3e6cff3c01931ed4da65220fde5 (diff)
[SKIP CI] update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 72ad59c..fc39b01 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,18 @@
![GitHub All Releases](https://img.shields.io/github/downloads/xoxys/hugo-geekdoc/total)
Geekdoc is a simple Hugo theme for documentations. This work is inspired and partially based on the [hugo-book](https://github.com/alex-shpak/hugo-book) theme.
+
+You can find the full documentation under [geekdocs.de](https://geekdocs.de)
+
+### Screenshots
+
+![Screenshot Desktop](https://github.com/xoxys/hugo-geekdoc/blob/master/local_media/desktop.png)
+![Screenshot Mobile](https://github.com/xoxys/hugo-geekdoc/blob/master/local_media/mobile.png)
+
+### License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+### Maintainers and Contributors
+
+[Robert Kaussow](https://github.com/xoxys)