Readme

README.md

@@ -4,18 +4,41 @@ This plugin allows time to logged from ChromePlugin tickets into a Kimai instanc
 
 ## Installation
 
-This is a bit messed up.  A ChromePlugin power up runs by requesting a set up page 
-from a given URL that has some javascript that sets up the callbacks for the 
-board and card.  The problem is that the powerup has a single URL set in the 
-ChromePlugin admin screen.  This needs to point at you Kimai install. So...
+### The plugin
 
-Download and install this power up in var/plugins like normal, then go here: 
-[Power ups admin](https://ChromePlugin.com/power-ups/admin) and create a power up, 
-it doesn't matter what it is called but set the "Iframe Connector URL" to 
-point to the path ```/ChromePlugin/powerup```, e.g. 
-https://kimai.neontribe.co.uk/ChromePlugin/powerup
+Clone the repo into your plugins folder of a Kimai installation (it must be in a folder named ```ChromePluginBundle```:
 
-Fill in sensible details for the othe fields and save the page. 
+    cd /path/to/kimai
+    cd var/plugins
+    clone https://github.com/tobybatch/ChromeKimaiBridge.git ChromePluginBundle
 
-Now goto the board you want to enable the power up. Show the menu on the right 
-hand side of the board 
+Reload the plugins:
+
+    cd /path/to/kimai
+    ./bin/console kimai:reload
+
+### The chrome extension
+
+Right now it's not in the chrome store, it will be, but for now there is a packed crx file in the var/plugins/ChromePluginBundle/Resources/ folder.
+
+Get it [here](https://github.com/tobybatch/ChromeKimaiBridge/blob/master/Resources/chrome.crx).
+
+## Set up
+
+This will add a new icon to your chrome extensions.  The first time you click it you will launch the options page.  Here you must add a URL pointing to the web root of you Kimai server.  Save the options and then you can use the extension.
+
+## Linking to Trello/Github
+
+Time can be logged directly against a project from a Github issue/project or Trello board.
+
+ 1. Navigate to the Github issue/project or Trello board, and open any card.
+ 1. Activate the extension, the white arrow in a green circle.
+ 1. The pop up will say it cannot find a project associated with this board.
+ 1. Copy the ID, e.g. ```tobybatch_ChromeKimaiBridge```
+ 1. Log into Kimai as an admin and navigate to the project you want to associate with this project.
+ 1. Edit the project, you will find a field call **External Board ID**
+ 1. Enter the board id and save the project.
+ 1. Return to the github issue/trello card and activate the extension.
+ 1. Log time and view logged history.
+
+The external board id accepts multiple board references in a comma seperated list.