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-09-11 21:24:29 +0300
committerRobert Kaussow <mail@geeklabor.de>2020-09-11 21:24:29 +0300
commitde17aec4043fc5b0e60b3d8da0a5a02d1478feea (patch)
tree91651ccf5824cbe688aa19da12f3de00595b0a43 /README.md
parenta81f85884808f684215866da358082f21f6412e9 (diff)
improve readme and screenshots
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.md b/README.md
index dc96221..ffc8070 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,21 @@
-# Hugo Geekdoc Theme
+# Geekdoc
[![Build Status](https://img.shields.io/drone/build/xoxys/hugo-geekdoc?logo=drone)](https://cloud.drone.io/xoxys/hugo-geekdoc)
[![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io)
[![GitHub release](https://img.shields.io/github/v/release/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/releases/latest)
+[![GitHub contributors](https://img.shields.io/github/contributors/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/graphs/contributors)
[![License: MIT](https://img.shields.io/github/license/xoxys/hugo-geekdoc)](LICENSE)
-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 a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de).
+Geekdoc is a simple Hugo theme for documentations. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de).
-![Screenshot](https://github.com/xoxys/hugo-geekdoc/blob/master/images/screenshot.png)
+![Preview Desktop](https://github.com/xoxys/hugo-geekdoc/blob/master/images/rm-desktop.png) ![Preview Mobile](https://github.com/xoxys/hugo-geekdoc/blob/master/images/rm-mobile.png)
-## License
+## Contributors
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+Special thanks goes to all [contributors](https://github.com/xoxys/hugo-geekdoc/graphs/contributors).
-## Maintainers and Contributors
+Geekdoc is inspired and partially based on the [hugo-book](https://github.com/alex-shpak/hugo-book) theme, thanks [Alex Shpak](https://github.com/alex-shpak/) for your work.
-[Robert Kaussow](https://github.com/xoxys)
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.