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

github.com/tosi29/inkblotty.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortosi <tosi16@gmail.com>2019-03-22 17:05:43 +0300
committerGitHub <noreply@github.com>2019-03-22 17:05:43 +0300
commit1e855da71bf25153f23823f91980cb6234135046 (patch)
treef8f2d9020dc1d9612e8680e27b6e7b905e7264fa /README.md
parent268ce6231f7c3855f5813af87b5e50348d5181db (diff)
Update README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 32 insertions, 1 deletions
diff --git a/README.md b/README.md
index d7c4060..cf697a7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,32 @@
-# inkblotty
+# Inkblotty
+Inkblotty is a Hugo theme based on [Inkblot](https://github.com/mgsisk/inkblot).
+
+## Features
+
+- Article
+ - Share Button (Facebook, Twitter, Hatena Bookmark)
+ - Comment form (Disqus)
+ - Related Posts
+- Article list
+ - Summarize and Readmore
+- Sidebar
+ - Category list
+ - Tag cloud
+ - Recent Posts
+ - Archives
+- Others
+ - Google Analytics
+
+
+## Installation
+1. Put theme directory into `themes` of your hugo site.
+ - Run git command in `themes` directory:
+ ```
+ git clone https://github.com/tosi29/inkblotty.git
+ ```
+ - Or, download and extract [zip file](https://github.com/tosi29/inkblotty/archive/master.zip), and put directory into `themes` directory as `inkblotty`.
+
+2. Edit `config.toml` of your hugo site.
+
+## Configuration
+[exampleSite/config.toml](https://github.com/tosi29/inkblotty/blob/master/exampleSite/config.toml) is for reference.