diff options
Diffstat (limited to 'recipes/aws-workmail/README.md')
-rw-r--r-- | recipes/aws-workmail/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/recipes/aws-workmail/README.md b/recipes/aws-workmail/README.md new file mode 100644 index 0000000..dcdfe59 --- /dev/null +++ b/recipes/aws-workmail/README.md | |||
@@ -0,0 +1,21 @@ | |||
1 | # franz-aws-workmail-plugin | ||
2 | |||
3 | [![GitHub release](https://img.shields.io/github/release/yoavmmn/franz-aws-workmail-plugin.svg)](https://github.com/yoavmmn/franz-aws-workmail-plugin/releases/latest) | ||
4 | [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/yoavmmn/franz-aws-workmail-plugin/master/LICENSE) | ||
5 | |||
6 | The minimum required version of Franz to run custom integrations is 4.0.0. You can download the latest version of Franz [here](http://meetfranz.com/#download_all). | ||
7 | |||
8 | ## Installation | ||
9 | 1. To install this plugin, use one of the following methods to clone the repository: | ||
10 | * Download the zip file from the [latest release](https://github.com/yoavmmn/franz-aws-workmail-plugin/releases/latest) | ||
11 | * git: `git clone https://github.com/yoavmmn/franz-aws-workmail-plugin.git` | ||
12 | * wget: `wget https://github.com/yoavmmn/franz-aws-workmail-plugin/archive/master.zip` | ||
13 | 2. Open the Franz Plugins folder on your machine: | ||
14 | * Linux: `~/.config/Franz/Plugins` | ||
15 | * Mac: `~/Library/Application\ Support/Franz/Plugins/` | ||
16 | * Windows: `%appdata%/Franz/Plugins` | ||
17 | * _Alternatively: Go to your Franz settings page, scroll down to the bottom and you will see an option to "Open the Franz plugin directory"_ | ||
18 | 3. Copy the `franz-aws-workmail-plugin` folder into the plugins directory | ||
19 | 4. Restart Franz | ||
20 | |||
21 | Thats it. Enjoy. | ||