Merge pull request #134 from alberanid/master

improve docs and screenshots

README.md

@@ -9,7 +9,7 @@ Main features:
 - quickly mark a registered person as an attendee
 - easy way to add a new person, if it's already known from a previous event or if it's a completely new person
 - can import Eventbrite CSV export files
-- RESTful interface
+- RESTful interface that can be called by third-party applications (see the https://github.com/raspibo/event_man/ repository for a simple script that checks people in using a barcode/QR-code reader)
 - ability to run triggers to respond to an event (e.g. when a person is marked as attending to an event)
 
 See the *screenshots* directory for some images.

docs/DEVELOPMENT.md

@@ -1,10 +1,9 @@
-Goals
+Definitions
-=====
+===========
 
-Definitions:
 - **event**: a faire, convention, congress or any other kind of meeting
 - **registered person**: someone who said it will attend at the event
-- **attendee**: a person who actually *show up* (checked in) at the event
+- **attendee**: a person who actually *show up* (is checked in) at the event
 
 
 Paths
@@ -13,7 +12,7 @@ Paths
 Webapp
 ------
 
-These are the path you see in the browser (AngularJS does client-side routing: no request is issued to the web server, during navigation, if not for fetching data and issuing commands):
+These are the paths you see in the browser (AngularJS does client-side routing: no request is issued to the web server, during navigation, if not for fetching data and issuing commands):
 
 - /#/events - the list of events
 - /#/event/new - edit form to create a new event
@@ -51,8 +50,8 @@ The paths used to communicate with the Tornado web server:
 - /login - login form
 - /logout - when visited, the user is logged out
 
-Notice that the above path are the ones used by the webapp. If you plan to use them from an external application (like the _eventman_ barcode/qrcode scanner) you better prepend all the path with /v1.0, where 1.0 is the current value of API\_VERSION.
+Notice that the above paths are the ones used by the webapp. If you plan to use them from an external application (like the _event\_man_ barcode/qrcode scanner) you better prepend all the path with /v1.0, where 1.0 is the current value of API\_VERSION.
-The main advantage in doing so is that, for every call, a useful status code and a JSON value is returned (also for /v10/login that usually would show you the login page).
+The main advantage of doing so is that, for every call, a useful status code and a JSON value is returned (also for /v1.0/login that usually would show you the login page).
 
 Also, remember that most of the paths can take query parameters that will be used as a filter, like GET /events/:event_id/persons?name=Mario
 
@@ -165,7 +164,6 @@ Nice to have
 ------------
 
 - a test suite
-- join the page used to add persons/events into the lists (shown when the filter field returns nothing and/or when a button is pressed)
 - notifications for form editing and other actions
 - authentication for administrators
 - i18n