Amended readme to clarify deloyment options, closes #116

readme.md

@@ -8,11 +8,30 @@ FLL Scoring
 
 To have a look at what we are at, see [Testing](https://github.com/FirstLegoLeague/fllscoring/wiki/Testing). No guarantees.
 
-Development prerequisites
+Using
 ---------------
 
+Currently the scoring application can only be reliably used as a hosted service. To use:
+
+- set up a server running nodejs [nodejs.org](http://nodejs.org)
+- [download the source](https://github.com/FirstLegoLeague/fllscoring/archive/master.zip) or clone the repository using git.
+- `npm install`
+- `node localserver.js` then open [localhost:1390](http://localhost:1390)
+    - to specify another port, use `node localserver.js -p 8000`
+    - to add basic authentication, use `node localserver.js -u username:password`
+
+In the near future, we plan to have "ready to go" software available as:
+
+- executable, for Windows, Mac OS and Linux
+- app, for iOS, Android and windows
+- a hosted service, as described above
+
+Development
+---------------
+
+Prerequisites
+
 - nodejs [nodejs.org](http://nodejs.org). Make sure you have a recent version (>.10)
-- bower (`npm install -g bower`)
 - grunt (`npm install -g grunt-cli`)
 
 Steps
@@ -80,12 +99,12 @@ License
 This projected is licensed under the terms of the [GNU GPL v2.0 licenses](https://raw.githubusercontent.com/FirstLegoLeague/fllscoring/master/LICENSE.txt)
 
 Basically, it allows users to legally copy, distribute and modify software. This means you can:
-* Copy it onto your own servers, your client’s servers, your own computer, pretty much anywhere you want. There’s no limit to the number of copies you can make. 
+* Copy it onto your own servers, your client’s servers, your own computer, pretty much anywhere you want. There’s no limit to the number of copies you can make.
 * Provide a download link on your website. Put the software on a bunch of thumb drives and give them away. Print out the source code and throw it from the rooftops (please don’t, though, because that would waste a lot of paper and make a mess).
 Charge a fee to distribute the software.
 * If you want to charge someone to provide the software, set it up on their website or do anything else related to it, you can do so. But, you must give them a copy of the GNU GPL, which basically tells them that they could probably get the software elsewhere for free. Best to be up front about that, and about why you’re charging them.
-* If you want to add or remove functionality, go ahead. If you want to use a portion of the code in another project, you can. The only catch is that the other project must also be released under the GPL. Ideally we would want you to share your improvements back with us on this GitHub. 
-* We welcome your feedback but please remember that this software comes with no guarantees. We are dedicated volunteer and experiences software developpers and will do our best make sure we make a valuable and reliable contribution to the community. However the use of this software is at your own risk.  
+* If you want to add or remove functionality, go ahead. If you want to use a portion of the code in another project, you can. The only catch is that the other project must also be released under the GPL. Ideally we would want you to share your improvements back with us on this GitHub.
+* We welcome your feedback but please remember that this software comes with no guarantees. We are dedicated volunteer and experiences software developpers and will do our best make sure we make a valuable and reliable contribution to the community. However the use of this software is at your own risk.
 
 Authors
 --------