From: Raivis Vitols <viitols.raivis@gmail.com>
Date: Tue, 16 Feb 2016 16:40:52 +0000 (+0200)
Subject: Added readme file
X-Git-Tag: v2.0~10
X-Git-Url: https://git.njae.me.uk/?a=commitdiff_plain;h=13e9356027c9f809b2bc9bca6c799f7af0e96217;p=ghost-theme-willow.git

Added readme file
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..334b06c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Willow Ghost Theme
+Personal, responsive, minimalist and open-source theme for Ghost blogging platform.
+
+## Demo
+This theme is currenly being used on my [personal blog](https://raivis.com/).
+
+## Features
+- Minimalist, focuses on content;
+- Incredibly lightweight theme;
+
+## Notes
+
+### Styling & Compiling
+
+Requires Compass to be installed.
+
+    cd content/themes/[theme-folder]/assets/scss && compass watch ./
+    
+
+### Adding Disqus
+
+Open the `content/themes/[theme-folder]/post.hbs` file, 
+lookup `/* Paste Your Disqus Embed Code Here */` 
+line and replace it with your Disqus embed code.
+
+### Social Links
+
+Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file.
+
+### Personal Branding
+
+Update `content/themes/[theme-folder]/default.hbs` and 
+`content/themes/[theme-folder]/partials/mobile-header.hbs`
+files to remove "John Doe" and "Lorem ipsum..." references.