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 0c8ca93c0783ed207b3abb5d9661ddabbd648d94..4750ff908d21df62879e5ecbd3846d48129ed767 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,33 +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
 
-![Willow Ghost Theme](http://i.imgur.com/gGNeWzG.png)
+This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/).
 
-## Demo
-This theme is currenly used on my [personal blog](https://raivis.com/).
+## Compiling SASS & Minifying JavaScript
 
-## Styling & Compiling
+Requires Grunt task runner & NPM to be installed.
 
-Requires [Compass](http://compass-style.org/) framework to be installed.
+    $ cd content/themes/[theme-folder]
+    $ npm install
+    $ grunt
 
-    $ cd content/themes/[theme-folder]/assets/scss
-    $ compass watch ./
-    
-## Adding Disqus
+## Editing Social Links and Promo Links
 
-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, which usually looks like this:
+Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file.
 
-    <script>
-        (function() {
-            var d = document, s = d.createElement('script');
-            s.src = '//yourdisqussite.disqus.com/embed.js';
-            s.setAttribute('data-timestamp', +new Date());
-            (d.head || d.body).appendChild(s);
-        })();
-    </script>
+## 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/