improve README

README.md

@@ -1,9 +1,29 @@
-Pay period remaining
+Pay periods remaining
 =====================
 
 Simple web application which helps to calculate pay periods, remaining in current year.
+The main idea behind the project was to create full-stack one page application using Python + JavaScript combination.
+It's main purpose is to prepare finished solution for simple real-world problem.
+Unfortunately, it lacks lot of UX/UI improvements and features (see TODO).
+Deployed on [ppr-askaliuk.rhcloud.com](http://ppr-askaliuk.rhcloud.com/)
 
-Current version: alpha
+# Components, frameworks, tools
+
+  * Backbone
+  * Twitter Bootstrap
+  * Handlebars templates
+  * brunch.io
+  * Jquery, LESS/SASS
+  * Mocha/Chai for js tests
+  * Flask on backend
+  * python-dateutil
+
+  Application skeleton: [askalyuk/brunch-banana-pancakes](https://github.com/askalyuk/brunch-banana-pancakes)
+
+# Dependencies
+
+    cd server && pip install -r requirements.txt
+    cd client && npm install
 
 # Server
 
@@ -13,7 +33,7 @@ Run development server:
 
 Run server tests:
 
-  server/run_tests.sh
+    server/run_tests.sh
 
 # Client
 
@@ -31,4 +51,5 @@ Production build:
 
 Client tests (on browser):
 
-    http://localhost:8002/static/test/index.html
+    http://localhost:8002/static/test/index.html
+    http://ppr-askaliuk.rhcloud.com/static/test/index.html

TODO

@@ -7,8 +7,9 @@ TODO:
  ✔ try to render frequency enum on server @done (13-04-11 15:09)
  ✔ implement correct calculation for end of the year @done (13-04-11 20:58)
  ✔ support for additional frequencies @done (13-04-12 15:56)
- ☐ improve README
+ ✔ improve README @done (13-04-17 16:25)
  ☐ implement "How it works" page
+ ☐ contribute back to skeleton
 
  Improvements:
  ☐ show payment calendar