From 1c6732836356b701b3524aa199cd08821f5853c6 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Sun, 10 Jan 2016 09:47:55 -0500 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ca442ea..d2ac5b0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#redmine_qbo +#Redmine Quickbooks Online ##About @@ -7,24 +7,37 @@ This is a simple plugin for Redmine to connect to Quickbooks Online The goal of this project is to allow redmine to connect with Quickbooks Online to create time activity entries for completed work when an issue is closed. ####How it works -* A QBO customer and service item can now be assigned to an issue. -* When a issue is closed, a new QBO Time Activity is created +* A QBO customer and service item can be assigned to a redmine issue. +* A QBO employee can be assigned to a redmine user +* When a issue is closed, the following things happen: + - The plugin checks to see if the user assinged to the issue has a QBO employee assinged to them + - The plugin checks to see if the issue has a QBO customer & service item attached + - If the above statements are true, then a new QBO Time Activity is created - The total time for the Time Activity will be total spent time. - The rate will be the set be the service item -*Warning: * This is under heavy development - ##Prerequisites -Sign up to become a developer for Intuit https://developer.intuit.com/ +* Sign up to become a developer for Intuit https://developer.intuit.com/ +* Create your own aplication to obtain your API keys ##The Install -To install, clone into your plugin folder and migrate your database. Then navigate to the plugin configuration page (https://your.redmine.com/settings/plugin/redmine_qbo) and suppy your own OAuth key & secret. +1. To install, clone this repo into your plugin folder -After saving your key & secret, you need to click on the Authenticate link on the plugin configuration page to authenticate with QBO. + ' git clone git@github.com:rickbarrette/redmine_qbo.git ' + +2. Migrate your database -Once you are authenticated with QBO, you need to synchronize your database with QBO by clicking the sync link in the Quickbooks top menu (https://your.redmine.com/redmine/qbo) + ' rake redmine:plugins:migrate RAILS_ENV=production ' + +3. Navigate to the plugin configuration page (https://your.redmine.com/settings/plugin/redmine_qbo) and suppy your own OAuth key & secret. +4. After saving your key & secret, you need to click on the Authenticate link on the plugin configuration page to authenticate with QBO. +5. Enjoy + +Note: Customers and Employees with automaticly update during normail usage of redmine i.e. a page refresh + +Note:nService Items do not automaticly update at this time, if you add/remove service items you will need to synchronize your database with QBO by clicking the sync link in the Quickbooks top menu (https://your.redmine.com/redmine/qbo) ##License