Updated contents, esp. installation, update and customization instruc…

…tions.

README.md

@@ -8,7 +8,28 @@
 
 Advanced editable BattleReport platform for EVE Online.
 
-- Download at [`Releases`](https://github.com/ta2edchimp/BattleReporter/releases)
+Download the current version at [`Releases`](https://github.com/ta2edchimp/BattleReporter/releases).
+
+## Table of Contents
+
+1. What is BattleReporter
+2. Setup
+  1. Requirements
+  2. Installation
+  3. Enable Login via EVE-Online Single Sign On
+  4. User Permissions by Role in Corp
+3. Update
+4. Further Configuration
+  1. Integrate with Slack
+  2. Themeing BattleReporter
+5. License, Acknowledgements & Legal Stuff
+
+## What is BattleReporter
+
+BattleReporter is a user generated killboard for [EVE-Online](http://eve-online.com), that fetches a corporation's kills (and losses) from either [zKillboard](https://zkillboard.com/) or [EVE-Kill.Net](https://beta.eve-kill.net/) and generates reports from them, that can be  
+- manually amended (by adding logistics, videos and after action reports, ...),
+- corrected (e.g. by removing unrelated kills or losses),
+- clarified (you can specify a 3rd party, for example).
 
 ## Setup
 
@@ -26,19 +47,20 @@ Advanced editable BattleReport platform for EVE Online.
 
 The dependencies will be met by the use of [Composer](http://getcomposer.org/) during the automatic installation process.
 
-Ensure to have url rewriting enabled and set up properly in your web server for `Slim` to function as expected (see the corresponding [documentation](https://github.com/codeguy/Slim#setup-your-web-server) for more information on how to set this up correctly).
+### Installation
 
-### Installation:
-
-As of release `0.1.6`, a basic installer comes with BattleReporter. Run
+To install BattleReporter, go grab its latest [release](https://github.com/ta2edchimp/BattleReporter/releases/latest) and unzip it to your server and run
 
 	$ php install.php
 
-to launch it. The installer asks for some basic information regarding your installation of BattleReporter, uses [Composer](http://getcomposer.org) to meet the requirements (it will be installed into the installation directory if not present), create the BattleReporter's own database tables and set up the primary admin's user account.
+The installer asks for some basic information regarding your installation of BattleReporter, uses [Composer](http://getcomposer.org) to meet the requirements (it will be installed into the installation directory if not present), create the BattleReporter's own database tables and set up the primary admin's user account.
+
+Within BattleReporter's root directory, you'll find a `public` folder, which has to be set up as the web root.
+Refer to [this documentation](https://github.com/codeguy/Slim#setup-your-web-server) to see how to configure you web server for BattleReporter to work properly (ensure to have url rewriting enabled).
 
-#### Log in via EVE-O SSO
+#### Enable Login via EVE-Online Single Sign On
 
-As of release `0.2`, logging into the BattleReport with your EVE Online account is available via Single Sign On. In order to enable log in via EVE-O SSO, you must register your BattleReporter installation as an application in the [EVE Developers portal](https://developers.eveonline.com/). A verified e-mail address is required to register (don't worry this takes no more than hitting a button in the EVE Online Account Management and clicking a link in the e-mail you'll receive soon afterwards).
+Initially, BattleReporter can only be logged into using the admin account created during its installation. To log in with your EVE Online account is available via Single Sign On. In order to enable log in via EVE-O SSO, you must register your BattleReporter installation as an application in the [EVE Developers portal](https://developers.eveonline.com/). A verified e-mail address is required to register (don't worry this takes no more than hitting a button in the EVE Online Account Management and clicking a link in the e-mail you'll receive soon afterwards).
 
 When registering your BattleReporter installation in the EVE-Dev. portal, ensure to enter the correct `Callback URL`. Let's assume you installed BattleReporter to be available at `br.yourcorp.net` and you do not use SSL, the correct url would be
 
@@ -48,17 +70,17 @@ After hitting `Create Application`, you'll acquire a `Client ID` and a `Secret K
 
 #### User Permissions by Role in Corp
 
-As of release `0.3.5`, it is possible to provide an EVE Online API Key to let BattleReporter check its owner corporation's members and their roles. Users logging in with characters who possess the `Director` role can then get the permission to edit, (un)publish and delete other users' battle reports.
+During the installaton, it is possible to provide an EVE Online API Key to let BattleReporter check its owner corporation's members and their roles. Users logging in with characters who possess the `Director` role can then get the permission to edit, (un)publish and delete other users' battle reports.
 
 For this to work, when setting up an [API Key](https://community.eveonline.com/support/api-key/), it is required to be of type `Corporation` and having access to `MemberSecurity` (AccessMask: `512`).
 
 ## Update
 
-As of release `0.3.3`, an update script will assist you in the process of updating BattleReporter's components. Run
+To update your BattleReporter installation, simply download the latest [release](https://github.com/ta2edchimp/BattleReporter/releases/latest) and unzip it to your server and run
 
 	$ php update.php
 
-to launch it. It will update [Composer](http://getcomposer.org), update existing and install new dependencies, as well as update the database tables.
+to launch the automated update routine. It will update [Composer](http://getcomposer.org), update existing and install new dependencies, as well as update the database tables.
 
 You may use the updater to update or modify the EVE Online Data at anytime. Just replace the files within `/database` and run the update script again. (_Hint:_ the tables required for operation are `mapSolarSystems`, `invGroups` and `invTypes`).
 
@@ -68,7 +90,7 @@ You may use the updater to update or modify the EVE Online Data at anytime. Just
 
 Some of BattleReporter's functions are not yet covered by the `install` and `update` scripts. You'll have to setup and configure them manually by customizing your `config.php` file accordingly.
 
-### Integration to Slack
+### Integrate with Slack
 
 I sure hope, you know what `Slack` is. If not, head over to the [`Slack` web site](https://slack.com/) and see, why it is better for your corporation's communiation than any IRC, WhatsApp group or whatever you nullsec dwellers currently use to ping the cap pilots ;P
 
@@ -121,6 +143,11 @@ You may proceed to configure the `Slash Command` in Slack. Recommended settings
 
 Type `/battlereporter help` into the current channel's chat to get a list of options; Basically: enter `/battlereporter` (with or without appended `latest`) to post the latest created BattleReport, enter `/battlereporter list` to get a list of the 25 most recently created reports, or use `/battlereporter 123` to post the BattleReport with Id #123.
 
+## Themeing BattleReporter
+
+Currently, BattleReporter comes with only a default theme. You can easily create your own or modify the default theme by duplicating the `/public/themes/default` folder and making the necessary changes to the included html templates, css files or images.  
+BattleReporter uses `Twig` as its templating engine, so head over to [their excellent documentation](http://twig.sensiolabs.org/documentation) to see, what's possible.
+
 ## License, Acknowledgements & Legal Stuff
 
 BattleReporter is released unde the [Beerware License](https://tldrlegal.com/license/beerware-license); So, as long as you keep the included author information, feel free to do anything you want with the source codes.