Updating default Disqus src code
[ghost-theme-willow.git] / README.md
index 334b06c2c60253080af8134fae7ebe1b10449deb..4bea5c258bf05db04f4c7117f6ed7bb03f69ed4f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,34 +1,30 @@
-# Willow Ghost Theme
-Personal, responsive, minimalist and open-source theme for Ghost blogging platform.
+# Willow Ghost Theme 3.0
 
-## Demo
-This theme is currenly being used on my [personal blog](https://raivis.com/).
+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.
 
-## Features
-- Minimalist, focuses on content;
-- Incredibly lightweight theme;
+![Willow Ghost Theme](http://i.imgur.com/a8WfkoS.png)
 
-## Notes
+## Theme Demo
 
-### Styling & Compiling
+This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/).
 
-Requires Compass to be installed.
+## Compiling SASS & Minifying JavaScript
 
-    cd content/themes/[theme-folder]/assets/scss && compass watch ./
-    
+Requires Grunt task runner & NPM to be installed.
 
-### Adding Disqus
+    $ cd content/themes/[theme-folder]
+    $ npm install
+    $ grunt
 
-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.
+## Editing Social Links and Promo Links
 
-### Social Links
+Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file.
 
-Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file.
+## Enabling Disqus Comments Box
 
-### Personal Branding
+1. Edit the `content/themes/[theme-folder]/post.hbs` file, uncomment "comments" partial
+inclusion.
 
-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.
+2. Replace Disqus embed code with your site code - https://disqus.com/admin/universalcode/