Refactoring code, cleaning up some SASS, styling author and tag page, adding optional...

[ghost-theme-willow.git] / README.md

diff --git a/README.md b/README.md
index ae860b8524abc3471703e9b460e8e52f7b41182b..4750ff908d21df62879e5ecbd3846d48129ed767 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,23 +1,30 @@
-# Willow Ghost Theme
+# Willow Ghost Theme 3.0
+
 Personal, responsive, minimalist and open-source theme for Ghost blogging platform.
+Lightweight - only 2.9KB of CSS and 820B of JavaScript. No jQuery, vanilla JS only.
+Version 2.0 comes with SASS in BEM style using ITCSS (http://itcss.io/) architecture.
+
+![Willow Ghost Theme](http://i.imgur.com/a8WfkoS.png)
+
+## Theme Demo
+
+This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/).
 
-![Willow Ghost Theme](http://i.imgur.com/gGNeWzG.png)
+## Compiling SASS & Minifying JavaScript
 
-## Demo
-This theme is currenly being used on my [personal blog](https://raivis.com/).
+Requires Grunt task runner & NPM to be installed.
 
-### Styling & Compiling
+    $ cd content/themes/[theme-folder]
+    $ npm install
+    $ grunt
 
-Requires Compass to be installed.
+## Editing Social Links and Promo Links
 
-    cd content/themes/[theme-folder]/assets/scss && compass watch ./
-    
-### Adding Disqus
+Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file.
 
-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.
+## Enabling Disqus (https://disqus.com/) Comments
 
-### Editing Social Links
+1. Edit the `content/themes/[theme-folder]/post.hbs` file, uncomment "comments" partial
+block inclusion: turn `<!--{{> "comments"}}-->` into `{{> "comments"}}`.
 
-Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file.
+2. Replace Disqus embed code with your site code - https://disqus.com/admin/universalcode/