add screenshots and rework readme

README.md

@@ -1,25 +1,29 @@
 # TEAM ORGA
-This is the source for a web application to organize closed, not publicly
-groups, secured with a basic authentication. Following features are available:
 
-* register as new user and create a profile,
-* create a not publicly group and manage group data,
-* invite new, more group members,
+This is the source for a **web application to organize closed, not publicly
+groups**, secured with a basic authentication. Following features are available:
+
+* create a not publicly group and **manage group data**,
+* **register** as new **user** and create a profile,
+* **invite** new, more group **members**,
 * list group members,
-* make repeating events,
-* accept or deny participation of a event,
-* use event specific mail lists for accepter, refuser, sleeper,
-* create comments based on a single event,
-* show birthday widget,
-* backoffice interface.
+* make **repeating events**,
+* **accept** or **deny participation** of a event,
+* use event specific **mail lists** for accepter, refuser, sleeper,
+* create **comments** based on a single event,
+* see upcomming **birthdays** of fellows,
+* manage data within a simple [backoffice](#backoffice) interface.
+
+Event-Overview                                              | Event-Details
+----------------------------------------------------------- | -------------------------------------------------------
+![TEAM ORGA Overview](app/assets/images/event-overview.png) | ![TEAM ORGA Event](app/assets/images/event-details.png)
 
 Originally I started this project for my private sports group as a standalone
-version.
+version. But meanwhile there is also a **multitenant software as a service version**,
+which currently is in **private beta**. If you want to participate ping me for an **invitation**.
 
-But meanwhile there is also a multitenant version (Software as a Service),
-which currently is in private beta. If you want to participate ping me for an invitation.
+# Getting Started
 
-## General Information
 This project uses [Ruby](http://ruby-lang.org) on
 [Rails](http://rubyonrails.org) and twitter
 [bootstrap](https://github.com/twitter/bootstrap) for the responsive frontend
@@ -33,13 +37,8 @@ through the entire application, which requires
 [Capybara](https://github.com/jnicklas/capybara) to drive the application via
 its external interface the web pages.
 
-Bugs and feature requests can be filed via GitHub's [Issue
-Tracker](https://github.com/netzfisch/teamorga/issues).
-
-Pull-request are welcome.
-
-## Getting Started
 ### Fork and Clone
+
 There are just a couple of steps to get your private team organisation alive.
 Fork this repo at GitHub and than
 
@@ -48,24 +47,31 @@ Fork this repo at GitHub and than
     $ rake db:migrate
 
 ### Testing
+
 Check the specs in the console by
 
     $ rake db:test:prepare
     $ guard
 
 ### Development
-You don't need to setup a new group with fake users, to see what it feels like.
+
+You don't need to setup a fake group with users, to see what it feels like.
 Just seed the exisiting data
 
+    $ rake db:drop
+    $ rake db:migrate
     $ rake db:seed
-    $ foreman start
 
-We use foreman to start all processes via a 'Procfile' instead doing `$ rails server`.
-Than access the application via http://localhost:5000.
+or as one-liner `$ rake db:drop db:migrate db:seed`, which is much faster!
+Than we use foreman to start all processes via a 'Procfile' instead doing `$ rails server`:
+
+    $ foreman start
 
+Access the application via [http://localhost:5000](http://localhost:5000).
 Reach the console via `$ foreman run rails console` or `$ rails console`.
 
 ### Staging / Production
+
 For example deploy at heroku
 
 ```sh
@@ -79,7 +85,8 @@ $ heroku run rake db:migrate
 If erverything runs fine, heroku launches your application and "informs" you
 about the live url.
 
-## Backoffice
+# Backoffice
+
 The application comes with a basic admin interface to manage model data (CRUD):
 
 * Groupdata
@@ -98,19 +105,19 @@ with the "admin role". The first admin needs to be created manual within the con
 
 or via seeding data as described above!
 
-## Screenshot
+# Contribution
 
-*in production, seed data needs to be reworked ;-)*
-
-## Contribution
+Bugs and feature requests can be filed via GitHub's [Issue
+Tracker](https://github.com/netzfisch/teamorga/issues).  
+Pull-request are welcome:
 
 1. Fork it
 2. Create your feature branch: `$ git checkout -b my-new-feature-branch`
 3. Commit your changes `$ git commit -a -m 'add some awesome feature'`
 4. Push to the branch `$ git push origin my-new-feature-branch`
 5. Create a new pull request
 
-## License
+# License
 
 TEAM ORGA may be redistributed under the terms specified in the
 [LICENSE](LICENSE) file.