diff options
author | 2021-12-15 23:49:05 +0100 | |
---|---|---|
committer | 2021-12-15 23:49:05 +0100 | |
commit | fa2ebdda2c9697f9f7633ef2f7c7b5941b5291f6 (patch) | |
tree | 3c9138790d672ff84071bba8e441149c245a80e7 | |
parent | Move nightlies block to CONTRIBUTING.md (diff) | |
download | ferdium-app-fa2ebdda2c9697f9f7633ef2f7c7b5941b5291f6.tar.gz ferdium-app-fa2ebdda2c9697f9f7633ef2f7c7b5941b5291f6.tar.zst ferdium-app-fa2ebdda2c9697f9f7633ef2f7c7b5941b5291f6.zip |
Iterate on README [skip ci]
-rw-r--r-- | README.md | 145 |
1 files changed, 32 insertions, 113 deletions
@@ -11,73 +11,22 @@ | |||
11 | 11 | ||
12 | # Ferdi | 12 | # Ferdi |
13 | 13 | ||
14 | <p align="center"> | 14 | <p> |
15 | <img alt="GitHub Releases" src="https://img.shields.io/github/downloads/getferdi/ferdi/latest/total?label=Downloads&logo=iCloud&logoColor=%23FFFFFF"> | 15 | <a href="https://github.com/getferdi/ferdi/actions/workflows/builds.yml"><img alt="Build Status" src="https://github.com/getferdi/ferdi/actions/workflows/builds.yml/badge.svg?branch=develop&event=push"></a> |
16 | <a title="Crowdin" target="_blank" href="https://crowdin.com/project/getferdi"><img src="https://badges.crowdin.net/getferdi/localized.svg"></a> | ||
17 | <img alt="GitHub Releases" src="https://img.shields.io/github/downloads/getferdi/ferdi/latest/total?label=downloads"> | ||
16 | <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | 18 | <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> |
17 | <a href='#contributors-'><img src='https://img.shields.io/badge/contributors-115-default.svg?logo=github' alt='Contributors'/></a> | 19 | <a href='#contributors-'><img src='https://img.shields.io/badge/contributors-115-default.svg?logo=github' alt='Contributors'/></a> |
18 | <!-- ALL-CONTRIBUTORS-BADGE:END --> | 20 | <!-- ALL-CONTRIBUTORS-BADGE:END --> |
19 | <a href="#backers-via-opencollective"><img alt="Open Collective backers" src="https://img.shields.io/opencollective/backers/getferdi?logo=open-collective"></a> | 21 | <a href="#backers-via-opencollective"><img alt="Open Collective backers" src="https://img.shields.io/opencollective/backers/getferdi?logo=open-collective"></a> |
20 | <a href="https://github.com/getferdi/ferdi/actions/workflows/ferdi-builds.yml"><img alt="Build Status" src="https://github.com/getferdi/ferdi/actions/workflows/ferdi-builds.yml/badge.svg?branch=develop&event=push"></a> | ||
21 | <a href="https://gitter.im/getferdi/community"><img alt="Gitter Chat Room" src="https://img.shields.io/gitter/room/getferdi/community"></a> | 22 | <a href="https://gitter.im/getferdi/community"><img alt="Gitter Chat Room" src="https://img.shields.io/gitter/room/getferdi/community"></a> |
22 | </p> | 23 | </p> |
23 | 24 | ||
24 | 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. | 25 | > 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. |
25 | |||
26 | ## Table of contents | ||
27 | |||
28 | <details> | ||
29 | <summary>Toggle navigation</summary> | ||
30 | |||
31 | - [Ferdi](#ferdi) | ||
32 | - [Table of contents](#table-of-contents) | ||
33 | - [What is Ferdi?](#what-is-ferdi) | ||
34 | - [Features](#features) | ||
35 | - [What does Ferdi look like?](#what-does-ferdi-look-like) | ||
36 | - [How to get and start using Ferdi](#how-to-get-and-start-using-ferdi) | ||
37 | - [Download Ferdi](#download-ferdi) | ||
38 | - [Or use Chocolatey (Windows only)](#or-use-chocolatey-windows-only) | ||
39 | - [Or use Windows Package Manager (Windows only)](#or-use-windows-package-manager-windows-only) | ||
40 | - [Or use homebrew (macOS or Linux)](#or-use-homebrew-macos-or-linux) | ||
41 | - [Or use snap (Linux only)](#or-use-snap-linux-only) | ||
42 | - [Or use AUR (Arch Linux)](#or-use-aur-arch-linux) | ||
43 | - [What makes Ferdi different from Franz?](#what-makes-ferdi-different-from-franz) | ||
44 | - [Removes unproductive paywalls and other other interruptions](#removes-unproductive-paywalls-and-other-other-interruptions) | ||
45 | - [Adds features to increase your productivity](#adds-features-to-increase-your-productivity) | ||
46 | - [Adds features to improve your privacy](#adds-features-to-improve-your-privacy) | ||
47 | - [Adds features to improve your experience using Ferdi](#adds-features-to-improve-your-experience-using-ferdi) | ||
48 | - [Fixes bugs](#fixes-bugs) | ||
49 | - [Adds new platforms](#adds-new-platforms) | ||
50 | - [Adds internal changes](#adds-internal-changes) | ||
51 | - [Contributing to Ferdi's development](#contributing-to-ferdis-development) | ||
52 | - [Nightly releases](#nightly-releases) | ||
53 | - [Troubleshooting recipes (self-help)](#troubleshooting-recipes-self-help) | ||
54 | - [Contributors ✨](#contributors-) | ||
55 | - [Backers via Open Collective](#backers-via-open-collective) | ||
56 | - [Sponsors](#sponsors) | ||
57 | </details> | ||
58 | |||
59 | ## What is Ferdi? | ||
60 | 26 | ||
61 | Ferdi is a desktop app that helps you organize how you use your favourite apps by combining them into one application. It is based on Franz - a software already used by thousands of people - with the difference that Ferdi gives you many additional features and doesn't restrict its usage! Furthermore, Ferdi is compatible with your existing Franz account, so you can continue right where you left off. Please find out more about Ferdi and its features on [getferdi.com](https://getferdi.com). | 27 | Ferdi is a desktop app that helps you organize how you use your favourite apps by combining them into one application. It is based on Franz - a software already used by thousands of people - with the difference that Ferdi gives you many additional features and doesn't restrict its usage! Furthermore, Ferdi is compatible with your existing Franz account, so you can continue right where you left off. Please find out more about Ferdi and its features on [getferdi.com](https://getferdi.com). |
62 | 28 | ||
63 | ## Features | 29 | ## Screenshots |
64 | |||
65 | - [x] Ferdi puts all your web apps into one place | ||
66 | - [x] Native support for 219 services | ||
67 | - [x] Workspaces to keep your personal and work life separated | ||
68 | - [x] Support for multiple accounts on any service | ||
69 | - [x] Dark Mode support for all of your services | ||
70 | - [x] Optional cloud sync to keep your services synchronized between devices | ||
71 | - [x] Better control over when you get which notifications | ||
72 | - [x] Cross-platform so you can view your services on all your computers | ||
73 | - [x] Full proxy support to work in every network environment | ||
74 | - [x] Ferdi speaks your language: Support for 20+ languages | ||
75 | |||
76 | ...and best of all: | ||
77 | |||
78 | - [x] Its completely free! There are no restrictions on features, no paywalls, no ads | ||
79 | |||
80 | ## What does Ferdi look like? | ||
81 | 30 | ||
82 | <details> | 31 | <details> |
83 | <summary>Toggle screenshots</summary> | 32 | <summary>Toggle screenshots</summary> |
@@ -93,49 +42,18 @@ Ferdi is a desktop app that helps you organize how you use your favourite apps b | |||
93 | </p> | 42 | </p> |
94 | </details> | 43 | </details> |
95 | 44 | ||
96 | ## How to get and start using Ferdi | 45 | ## Download |
97 | |||
98 | ### Download Ferdi | ||
99 | |||
100 | You can download Ferdi for Windows, Mac and Linux on [Ferdi's download page](https://getferdi.com/download) or you can find all variants in the [latest stable release](https://github.com/getferdi/ferdi/releases/latest) assets and [all the other releases here](https://github.com/getferdi/ferdi/releases). | ||
101 | |||
102 | ### Or use Chocolatey (Windows only) | ||
103 | |||
104 | `$ choco install ferdi` | ||
105 | |||
106 | (Don't know Chocolatey? [chocolatey.org](https://chocolatey.org/)) | ||
107 | |||
108 | ### Or use Windows Package Manager (Windows only) | ||
109 | |||
110 | `$ winget install --id AmineMouafik.Ferdi` | ||
111 | |||
112 | (Don't know winget? [winget-cli](https://github.com/microsoft/winget-cli/)) | ||
113 | |||
114 | ### Or use homebrew (macOS or Linux) | ||
115 | 46 | ||
116 | `$ brew install --cask ferdi` | 47 | 👉 [getferdi.com/download](https://getferdi.com/download/) |
117 | 48 | ||
118 | (Don't know homebrew? [brew.sh](https://brew.sh/)) | 49 | Assets made available via [GitHub releases](https://github.com/getferdi/ferdi/releases/latest). |
119 | 50 | ||
120 | ### Or use snap (Linux only) | 51 | ## What makes Ferdi different from Franz? |
121 | |||
122 | `$ snap install ferdi` | ||
123 | |||
124 | You can find published releases as `stable`, `beta` and `nightly` channels on [snapcraft.io](https://snapcraft.io/ferdi). | ||
125 | |||
126 | (Don't know snap? [snapcraft.io](https://snapcraft.io/)) | ||
127 | |||
128 | ### Or use AUR (Arch Linux) | ||
129 | |||
130 | Ferdi has three separate AUR packages you can use: | ||
131 | |||
132 | - **[ferdi](https://aur.archlinux.org/packages/ferdi/)**: Uses your system electron version to run the latest release - this version will work best on most systems. | ||
133 | - **[ferdi-bin](https://aur.archlinux.org/packages/ferdi-bin/)**: Uses the latest Fedora release and extracts it to Arch. Use this version if you are having trouble with the `ferdi` package. | ||
134 | - **[ferdi-git](https://aur.archlinux.org/packages/ferdi-git/)**: Uses your system electron version to run the latest commit from the develop branch and may be unstable but may also give you features that are not yet available in other versions. Please only use `ferdi-git` if you accept these risks. | ||
135 | 52 | ||
136 | If you use an AUR Helper, e.g. yay, install it via `yay -S ferdi`. | 53 | _Find answers to other frequently asked questions on [getferdi.com/faq](https://getferdi.com/faq/)._ |
137 | 54 | ||
138 | ## What makes Ferdi different from Franz? | 55 | <details> |
56 | <summary>Toggle answer</summary> | ||
139 | 57 | ||
140 | ### Removes unproductive paywalls and other other interruptions | 58 | ### Removes unproductive paywalls and other other interruptions |
141 | 59 | ||
@@ -234,21 +152,16 @@ If you use an AUR Helper, e.g. yay, install it via `yay -S ferdi`. | |||
234 | - [x] Adds retry commands to flaky build steps ([#498](https://github.com/getferdi/ferdi/issues/498)) | 152 | - [x] Adds retry commands to flaky build steps ([#498](https://github.com/getferdi/ferdi/issues/498)) |
235 | - [x] Runs utility scripts pre-commit instead of pre-push ([#515](https://github.com/getferdi/ferdi/issues/515)) | 153 | - [x] Runs utility scripts pre-commit instead of pre-push ([#515](https://github.com/getferdi/ferdi/issues/515)) |
236 | 154 | ||
237 | > Thanks to all our [contributors](#contributors-) who helped realize all these amazing features! 💖 | 155 | </details> |
238 | |||
239 | ## Contributing to Ferdi's development | ||
240 | |||
241 | We welcome all contributors. Please read the [contributing guidelines](CONTRIBUTING.md) to setup your development machine and proceed. | ||
242 | |||
243 | ## Nightly releases | ||
244 | 156 | ||
245 | Nightly releases are automatically triggered every day ([details](https://github.com/getferdi/ferdi/pull/990)) and available in [getferdi/ferdi](https://github.com/getferdi/ferdi/releases). Maintainers still need to verify and manually publish the draft releases as pre-releases for now. | 157 | ## Troubleshooting [recipes](https://github.com/getferdi/recipes) |
246 | 158 | ||
247 | ## Troubleshooting recipes (self-help) | 159 | <details> |
160 | <summary>Toggle answer</summary> | ||
248 | 161 | ||
249 | One of the issues being raised by the awesome users of Ferdi is that certain service-functionalities do not work. As good example of this is either the unread count (badge) stops working for specific services or the gmail logins don't work anymore. (These are just 2 of the most common problems reported). | 162 | One of the issues being raised by the users of Ferdi is that certain service-functionalities do not work. As good example of this is either the unread count (badge) stops working for specific services or the gmail logins don't work anymore. (These are just 2 of the most common problems reported). |
250 | 163 | ||
251 | Since we (the contributors to Ferdi) also eat our own dog food, we use Ferdi as our day-to-day communication app - and most likely have faced the same/similar issue. As a first step before filing an issue, we request you to follow these simple steps to see if the issue gets fixed. These recipes will get automatically upgraded when you upgrade to the newer versions of Ferdi, but to get new recipes **between** Ferdi releases, this documentation is quite useful. | 164 | Since we (the contributors to Ferdi) also eat our own food, we use Ferdi as our day-to-day communication app - and most likely have faced the same/similar issue. As a first step before filing an issue, we request you to follow these simple steps to see if the issue gets fixed. These recipes will get automatically upgraded when you upgrade to the newer versions of Ferdi, but to get new recipes **between** Ferdi releases, this documentation is quite useful. |
252 | 165 | ||
253 | - Make sure you are on the latest version of Ferdi. As of this writing, since the nightly CI packaging process is broken, we request you to download the latest nightly from the link in [Nightly releases](#nightly-releases) section. | 166 | - Make sure you are on the latest version of Ferdi. As of this writing, since the nightly CI packaging process is broken, we request you to download the latest nightly from the link in [Nightly releases](#nightly-releases) section. |
254 | - Stop Ferdi | 167 | - Stop Ferdi |
@@ -266,29 +179,35 @@ Since we (the contributors to Ferdi) also eat our own dog food, we use Ferdi as | |||
266 | - If this process did not fix the issue, please log a detailed bug report [here](https://github.com/getferdi/recipes/issues) | 179 | - If this process did not fix the issue, please log a detailed bug report [here](https://github.com/getferdi/recipes/issues) |
267 | - _Note:_ An automated process to perform these steps is being ideated and tracked [here](https://github.com/getferdi/ferdi/issues/1302) | 180 | - _Note:_ An automated process to perform these steps is being ideated and tracked [here](https://github.com/getferdi/ferdi/issues/1302) |
268 | 181 | ||
182 | </details> | ||
183 | |||
184 | ## Contributing | ||
185 | |||
186 | Please read the [contributing guidelines](CONTRIBUTING.md) to setup your development machine and proceed. | ||
187 | |||
269 | ## Contributors ✨ | 188 | ## Contributors ✨ |
270 | 189 | ||
271 | Thanks goes to these awesome people: | 190 | Special thanks goes to these awesome people: |
272 | 191 | ||
273 | <a href="https://github.com/getferdi/ferdi/contributors" target="_blank"><img src="https://opencollective.com/getferdi/contributors.svg?width=890&button=off"></a> | 192 | <a href="https://github.com/getferdi/ferdi/blob/develop/.all-contributorsrc" target="_blank"><img src="https://opencollective.com/getferdi/contributors.svg?avatarHeight=42&width=890&button=off"></a> |
274 | 193 | ||
275 | This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! | 194 | This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |
276 | 195 | ||
277 | ## Backers via Open Collective | 196 | ### Backers via Open Collective |
278 | 197 | ||
279 | <a href="https://opencollective.com/getferdi#section-contribute" target="_blank"><img src="https://opencollective.com/getferdi/backers.svg?width=890&button=off"></a> | 198 | <a href="https://opencollective.com/getferdi#section-contribute" target="_blank"><img src="https://opencollective.com/getferdi/backers.svg?avatarHeight=42&width=890"></a> |
280 | 199 | ||
281 | Mention to the individuals backing us via [GitHub Sponsors](https://github.com/sponsors/getferdi) as well. | 200 | Mention to the individuals backing us via [GitHub Sponsors](https://github.com/sponsors/getferdi) as well. |
282 | 201 | ||
283 | ## Sponsors | 202 | ### Sponsors |
284 | 203 | ||
285 | <p> | 204 | <p> |
286 | <a href="https://www.digitalocean.com/"> | 205 | <a href="https://www.digitalocean.com/"> |
287 | <img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" height="32px"> | 206 | <img src="https://getferdi.com/wp-content/uploads/sites/4/2021/09/digitalocean-logo-vector-1-1.svg" height="32px"> |
288 | </a> | 207 | </a> |
289 | </p> | 208 | </p> |
290 | <p> | 209 | <p> |
291 | <a href="https://www.parallels.com/"> | 210 | <a href="https://www.parallels.com/"> |
292 | <img src="https://user-images.githubusercontent.com/412895/141497533-f5e4a0b2-6ffa-4642-aa39-c117f7705780.png" height="32px"> | 211 | <img src="https://getferdi.com/wp-content/uploads/sites/4/2021/12/Parallels_logo.svg" height="30px"> |
293 | </a> | 212 | </a> |
294 | </p> | 213 | </p> |