From cea7a8964bc927fa9564910ec5f38c5bcd5ac631 Mon Sep 17 00:00:00 2001 From: Scott Carpenter Date: Tue, 15 Sep 2020 17:32:25 -0600 Subject: [PATCH] Add more info to README. Change the version to v1.1.0. --- README.md | 33 ++++++++++++++++++++++++++++----- package.json | 2 +- 2 files changed, 29 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 500e73b..a1308ee 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,42 @@ This is an unofficial Franz/Ferdi recipe for [Order Desk](https://www.orderdesk.com/). -The badge on the service icon will show the number of open orders in a specific folder. -Change the value of the `folderId` variable in `webview.js` to the ID of the folder -in Order Desk that you want to show the open order count for. +[GitHub repo](https://github.com/squatto/franz-recipe-orderdesk) -e.g. `https://app.orderdesk.me/orders?folder=123456` = `folderId 123456` +## Service Icon Badge -[GitHub repo](https://github.com/squatto/franz-recipe-orderdesk) +The badge on the service icon will show the number of open orders in a certain folder. +Change the value of the `folderId` variable in `webview.js` to the ID of the Order Desk folder +that you want to show the open order count for. + +You can easily get this by clicking the folder in the nav menu and then looking at the page URL. + +e.g. `https://app.orderdesk.me/orders?folder=123456` is `folderId 123456` + +## Automatic Page Reloading + +Order Desk doesn't automatically update the UI to reflect changes in the open order count, +so the page has to be reloaded to get the new count. By default this happens every 120 seconds +by automatically clicking the "Dashboard" link in the nav menu. + +If you want to change how this works (or disable it entirely) you can change it in `webview.js`: + +* Change the `callReloadCallbackAfter` variable to `-1` to disable automatic reloading +* Change the `callReloadCallbackAfter` variable to the number of seconds between automatic reloads +* Change the `reloadCallback` function to do whatever you want ## Installation Follow the instructions [here](https://blog.jakelee.co.uk/super-simple-guide-to-adding-a-new-ferdi-service-recipe/) and put the files in this repo in `/recipes/dev/orderdesk/` +## Changelog + +* **Version 1.1.0 - 09/15/2020** + * Add automatic reloading +* **Version 1.0.0 - 09/10/2020** + * Initial release + ### How to create your own Franz recipes * [Read the documentation](https://github.com/meetfranz/plugins) diff --git a/package.json b/package.json index 5f8e88e..139cedf 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "id": "orderdesk", "name": "Order Desk", - "version": "1.0.0", + "version": "1.1.0", "description": "Order Desk", "main": "index.js", "author": "Scott Carpenter ",