Merge pull request #5 from raivis-vitols/development

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

diff --git a/README.md b/README.md
index fed960471c35c64712450667ab1af533142d2320..4238a39af6a4ac52fc7a4909ecea21cf4305fa53 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,28 +1,23 @@
-# 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/).
+# Willow Ghost Theme 2.0
 
-## Features
-- Minimalist, focuses on content;
-- Incredibly lightweight theme;
+Personal, responsive, minimalist and open-source theme for Ghost blogging platform.
+Lightweight - only 2.8KB of CSS and 828B of JavaScript. No jQuery, vanilla JS only.
+Version 2.0 comes with SASS in BEM style using ITCSS (http://itcss.io/) architecture.
 
-## Notes
+![Willow Ghost Theme](http://i.imgur.com/a8WfkoS.png)
 
-### Styling & Compiling
+## Theme Demo
 
-Requires Compass to be installed.
+This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/).
 
-    cd content/themes/[theme-folder]/assets/scss && compass watch ./
-    
+## Compiling SASS & Minifying JavaScript
 
-### Adding Disqus
+Requires Grunt task runner & NPM to be installed.
 
-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.
+    $ cd content/themes/[theme-folder]
+    $ npm install
+    $ grunt
 
-### Social Links
+## Editing Social Links and Promo Links
 
-Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file.
\ No newline at end of file
+Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file.