Merge branch 'master' of https://github.com/l-lin/bulletular

README.md

@@ -1,4 +1,59 @@
-bulletular
-==========
+# Bulletular
 
-A simple Todo using keyboard shortcuts
+Bulletular is a TODO web application based on [AngularJS](http://angularjs.org/) and [AngularUI](http://angular-ui.github.io/).
+
+Bulletular functionnalities is mainly based on [Workflowy](https://workflowy.com/) ideas of keyboard shortcuts for completing, removing, moving tasks. 
+
+*Note: I use Workflowy everyday btw. I strongly recommend this application to organize thoughts/ideas/work*
+
+# Live demo
+
+See [demo](http://l-lin.github.io/bulletular/).
+
+# Getting started
+
+## Prerequisite
+
+In order to test this project, you will need the following applications installed:
+
+* [NPM](https://npmjs.org/):	A Node Packaged Modules manager
+* [BowerJS](https://github.com/bower/bower): A front-end package manager for the web that runs over Git.
+* [GruntJS](http://gruntjs.com/): A Javascript Task Runner
+
+## Get the source of Bulletular
+
+Clone the project :
+
+```
+$ git clone https://github.com/l-lin/bulletular.git
+```
+
+## Download dependencies
+
+Run `npm install` and `bower install`
+
+```
+$ cd bulletular
+$ bower install & npm install
+```
+
+## Run server
+
+You can run a server that will automatically refresh your browser when you modify the source code by executing the following command:
+
+```
+grunt server
+```
+
+Access with a browser to `http://localhost:9000`.
+
+**Note:** The server is of course not mandatory to test out the application.
+
+
+# About this project
+
+This project was created mainly for educational purpose.
+
+I was just doing some practice with AngularJS and it was also the opportunity to test out the Github pages.
+
+If you feel like you can do something out of it, go for it! Fork it and happy hacking! :)