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

github.com/djuelg/Shapez-Theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDominik Juelg <djuelg@gmx.de>2017-04-14 18:49:46 +0300
committerDominik Juelg <djuelg@gmx.de>2017-04-14 18:49:46 +0300
commitdf6b41ee3cdeb883a992f1fd3e1d9a758b87a90e (patch)
treeab0bd53baa0b160bc4215ce2c4bf498cfc45e45e
parentac31bdb2aa768bdc7becd13267fa43df0b4cc660 (diff)
Updated readme
-rw-r--r--README.md17
1 files changed, 11 insertions, 6 deletions
diff --git a/README.md b/README.md
index 279115d..2cb2aa9 100644
--- a/README.md
+++ b/README.md
@@ -3,20 +3,25 @@ Designed with passion and love.
Shapez is a modern hugo theme using a lot of SVG graphics.
SVG is super cool, but be aware - it can also be very nasty and exhausting.
-Demo: [http://djuelg.github.io/](http://djuelg.github.io/)
-Source: [https://github.com/djuelg/Shapez-Theme](https://github.com/djuelg/Shapez-Theme)
+- Demo: [https://themes.gohugo.io/theme/shapez-theme/](https://themes.gohugo.io/theme/shapez-theme/)
+- Source: [https://github.com/djuelg/Shapez-Theme](https://github.com/djuelg/Shapez-Theme)
-# What it's meant to be
+Note: Demo might be buggy because of absolute/relative links.
+
+## Screenshot
+![Screenshot](/images/screenshot.png)
+
+## What it's meant to be
Initially I designed this theme for my own blog, but I decided to make it an open source project, because I thought other people might like it, too.
If you want to use it feel free to do so, but be prepared to learn some SVG if you want to adapt the theme to your wishes.
-# How to use it
+## Getting started
- copy the file sample-config.toml to your project folder
- replace the file with your config file
- adapt the config according to your wishes
- you are good to go
-# Features
+## Features
- responsive use of inline SVG
- Timeline on the homepage
- Single pages to write your content
@@ -29,6 +34,6 @@ If you want to use it feel free to do so, but be prepared to learn some SVG if y
Attention! This theme isn't build with full Internet Explorer Support - feel free to create a merge request to add support.
-# Special Thanks
+## Special Thanks
Special thanks goes to [Freepik](http://www.flaticon.com/authors/freepik), [Daniel Bruce](http://www.flaticon.com/authors/Daniel%20Bruce) and [Plainicon](http://www.flaticon.com/authors/Plainicon) from [www.flaticon.com](http://www.flaticon.com) for their great icons! Furthermore I would like to thank [CrimsonRay](https://github.com/CrimsonRay), the creator of the slender-Theme. He inspired me to make my own theme and I reused some of his code.
Last but not least, I would like to thank the creator and all the contributors at [Hugo](http://gohugo.io) for their great work!