diff options
author | 2019-12-20 19:21:22 +0100 | |
---|---|---|
committer | 2019-12-20 19:21:22 +0100 | |
commit | 7dd617a524c85a14c266aa1568d3a9a77b791df5 (patch) | |
tree | 0094bcfc073ddf7825410840b9da3ba35679cf88 /uncompressed/mastodon/README.md | |
parent | Add update script (diff) | |
download | ferdium-recipes-7dd617a524c85a14c266aa1568d3a9a77b791df5.tar.gz ferdium-recipes-7dd617a524c85a14c266aa1568d3a9a77b791df5.tar.zst ferdium-recipes-7dd617a524c85a14c266aa1568d3a9a77b791df5.zip |
#15 Add mastodon recipe
Diffstat (limited to 'uncompressed/mastodon/README.md')
-rw-r--r-- | uncompressed/mastodon/README.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/uncompressed/mastodon/README.md b/uncompressed/mastodon/README.md new file mode 100644 index 0000000..b0477b6 --- /dev/null +++ b/uncompressed/mastodon/README.md | |||
@@ -0,0 +1,71 @@ | |||
1 | # Mastodon for Franz 5 | ||
2 | |||
3 | This is the [Franz](https://meetfranz.com/) 5 recipe for Mastodon | ||
4 | |||
5 | ## REQUIRED | ||
6 | |||
7 | * [Franz](https://meetfranz.com/) 5 or later | ||
8 | Do not support older version. | ||
9 | * [Mastodon](https://joinmastodon.org/) account | ||
10 | Do not have an account? | ||
11 | Choose from "[Mastodon instances](https://instances.social/list)"! | ||
12 | |||
13 | ## HOW TO INSTALL | ||
14 | |||
15 | ### DEVELOP VERSION | ||
16 | |||
17 | 1. download the `franz-recipe-mastodon` folder. | ||
18 | 2. Open the Franz Plugins folder on your machine (note **that this `dev` directory may not exist yet, and you must create it**): | ||
19 | * Mac: `~/Library/Application Support/Franz/recipes/dev/` | ||
20 | * Windows: `%AppData%\Franz\recipes\dev\` | ||
21 | * Linux: `~/.config/Franz/recipes/dev` | ||
22 | 3. Copy the `franz-recipe-mastodon` folder into the plugins directory | ||
23 | 4. Reload Franz | ||
24 | |||
25 | See [Franz Recipe Documentation / Overview](https://github.com/meetfranz/plugins/blob/master/docs/integration.md) | ||
26 | for details. | ||
27 | |||
28 | ### STABLE VERSION | ||
29 | |||
30 | *Coming Soon ...* | ||
31 | |||
32 | ## USAGE | ||
33 | |||
34 | ### ADD NEW SERVICE | ||
35 | |||
36 | ![](docs/add-service.png) | ||
37 | |||
38 | *develop version* | ||
39 | |||
40 | ### SETTINGS | ||
41 | |||
42 | ![](docs/add-service-settings.png) | ||
43 | |||
44 | | # | field | description | | ||
45 | |-|-|-| | ||
46 | | (1) | service name | Please set freely | | ||
47 | | (2) | Mastodon host | Please enter the host on which Mastodon is running. Only https is supported. | | ||
48 | |||
49 | ### SIGN-IN | ||
50 | |||
51 | ![](docs/mstdn_jp-signin.png) | ||
52 | |||
53 | Please enter registered account information. | ||
54 | |||
55 | ### NOTIFICATION BADGE | ||
56 | |||
57 | ![](docs/notification-badge-example.png) | ||
58 | |||
59 | In order to use it, desktop notification must be enabled on *mastodon* side. | ||
60 | |||
61 | | current actived service | clear badge | | ||
62 | |-|-| | ||
63 | | this service | At the end of 10 seconds from the last notice | | ||
64 | | other service | this service actived | | ||
65 | |||
66 | |||
67 | ## LICENSE | ||
68 | |||
69 | © 2018 sharkpp | ||
70 | |||
71 | This software is licensed under a [The MIT License](http://opensource.org/licenses/MIT). | ||