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

github.com/zhe/hugo-theme-slim.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZhe Zhang <neomana@gmail.com>2015-05-04 09:29:51 +0300
committerZhe Zhang <neomana@gmail.com>2015-05-04 09:29:51 +0300
commit7b6bb7c8d3b86d4f9e53f897e9a903553732a39c (patch)
treef758e303dd742fa50b2d90ce11fd8b39a9fcf30d
parentb1707eedd03bea8f8a6d9fb102f24d317e775f3e (diff)
update README
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
index b404c97..96bc150 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,48 @@
Slim is a minimal, clean and beautiful theme for [Hugo](http://gohugo.io/).
+![Slim screenshot](https://github.com/zhe/hugo-theme-slim/blob/master/images/screenshot.png)
+
[Demo](http://zhezhang.co).
+
+## Installation
+
+```
+mkdir themes
+cd themes
+git clone https://github.com/zhe/hugo-theme-slim slim
+```
+
+See the [official docs](http://gohugo.io/themes/installing) for more information.
+
+## Configuration
+You could add `params` into your site's `config.toml` file:
+
+```
+[params]
+ Subtitle = "Your site's subtitle/tagline"
+ GithubID = "Your Github ID"
+ TwitterID = "Your Twitter ID"
+ AnalyticsID = "Your Google Analytics tracking code"
+```
+
+if you use `config.yaml`, it could look like:
+
+```
+params:
+ Subtitle: "Your site's subtitle/tagline"
+ GithubID: "Your Github ID"
+ TwitterID: "Your Twitter ID"
+ AnalyticsID: "Your Google Analytics tracking code"
+```
+
+## Build your site
+
+```
+hugo server -t slim
+```
+
+
+## License
+
+Open sourced under [MIT license](https://github.com/zhe/hugo-theme-slim/blob/master/LICENSE.md).