From 68bfb24f955cef4837ab2e29fd2771e2682eab2a Mon Sep 17 00:00:00 2001 From: Adam Butler Date: Wed, 15 Oct 2014 20:58:58 +0100 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index bff04ae..52862b5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,29 @@ # Poll +Poll is a Ruby on Rails applications for conducting Polls simply and in real-time. Poll requires no registration to create or enter polls and the results page can be loaded while results are loaded in as they occour. + +Here are a few screensots from http://poll.lab.io + ![image](https://cloud.githubusercontent.com/assets/1238468/4652277/b9e13d4e-54a3-11e4-88a2-52d832787057.png) ![image](https://cloud.githubusercontent.com/assets/1238468/4652269/acce543e-54a3-11e4-9006-9fe4b0113557.png) ![image](https://cloud.githubusercontent.com/assets/1238468/4652272/b2063976-54a3-11e4-8a92-737827ec53cc.png) + +## Installing + +``` +$ git clone git@github.com:adambutler/poll.git +$ cd poll +$ bundle install +$ rake db:create +$ rake db:migrate +$ cp .env.example .env +``` + +Modify the `.env` file to match with your [Pusher](http://pusher.com) application credentials or setup [Slanger](https://github.com/stevegraham/slanger) (perhaps with [docker-slanger](https://github.com/adambutler/docker-slanger)) + + +## Contributing + +Contributions are welcome, please follow [GitHub Flow](https://guides.github.com/introduction/flow/index.html)