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

github.com/diwao/hestia-pure.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordiwao <nakapom@gmail.com>2018-03-19 11:20:12 +0300
committerdiwao <nakapom@gmail.com>2018-03-19 11:20:12 +0300
commit8ef7b0de06f47964e0ef6525492079131eab277f (patch)
treed1492d2cf851437834734d9e7fd243be46ee18af
parent3738e63ffe678888d24ab52aa2bbebae21d40633 (diff)
update readme
-rw-r--r--README.md45
-rw-r--r--static/image/theme/screenshot.pngbin0 -> 297288 bytes
2 files changed, 43 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6b9e4a1..7c715a1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,43 @@
-# hestia-pure
-Pure CSSを使ったHugo用のテーマ
+# Hestia Pure
+Hestia Pure is a simple hugo theme based PureCSS.
+
+![screenshot](./static/image/theme/screenshot.png)
+
+## Installation & Usage
+Clone this repository to your hugo theme directory.
+
+```
+$ git clone https://github.com/diwao/hestia-pure.git themes/
+$ hugo server --theme=hestia-pure --buildDrafts --watch
+```
+
+## Configuration
+In this theme you can add variables to your site config file. The following is the example config:
+
+```
+baseurl = "https://diwao.com/"
+languageCode = "ja"
+title = “diwao’s diary“
+theme = 'hestia-pure'
+
+[author]
+ author = 'diwao'
+ profile = 'I am a frontend engineer working in Sendai City, Japan.'
+ image = 'image/theme/profile.jpg'
+
+[Params]
+ localeOgp = "ja"
+ description = "This site is diwao's blog."
+ keywords = "Sendai,Mac,iPhone,Web"
+ twitter = "otaman517"
+ github = "diwao"
+ facebook = "diwaocom"
+ googleanalytics = "UA-12345678-9"
+ googlecustomsearch = "xxxxxxxxx"
+```
+
+## License
+MIT License
+
+## Author
+Daisuke Iwao
diff --git a/static/image/theme/screenshot.png b/static/image/theme/screenshot.png
new file mode 100644
index 0000000..ca51b53
--- /dev/null
+++ b/static/image/theme/screenshot.png
Binary files differ