Skip to content

Commit

Permalink
Add more info to README. Change the version to v1.1.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
squatto committed Sep 15, 2020
1 parent 07088e9 commit cea7a89
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 6 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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 <scott@payforstay.com>",
Expand Down

0 comments on commit cea7a89

Please sign in to comment.