aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar kytwb <kytwb@pm.me>2022-01-11 19:49:21 +0100
committerLibravatar kytwb <kytwb@pm.me>2022-01-11 19:49:21 +0100
commit53d5dd096fd5e8365d9324fa9c1e7d5e219d9671 (patch)
treeee8951812890fc3b7e5b4ebaae715f72b2022ebb /README.md
parentAdd PublishDebugInfo modal in AuthLayout (diff)
downloadferdium-app-53d5dd096fd5e8365d9324fa9c1e7d5e219d9671.tar.gz
ferdium-app-53d5dd096fd5e8365d9324fa9c1e7d5e219d9671.tar.zst
ferdium-app-53d5dd096fd5e8365d9324fa9c1e7d5e219d9671.zip
Iterate on README [skip ci]
Diffstat (limited to 'README.md')
-rw-r--r--README.md134
1 files changed, 1 insertions, 133 deletions
diff --git a/README.md b/README.md
index 881104327..4c50edafa 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,6 @@
18<a href='#contributors-'><img src='https://img.shields.io/badge/contributors-243-default.svg?logo=github' alt='Contributors'/></a> 18<a href='#contributors-'><img src='https://img.shields.io/badge/contributors-243-default.svg?logo=github' alt='Contributors'/></a>
19<!-- ALL-CONTRIBUTORS-BADGE:END --> 19<!-- ALL-CONTRIBUTORS-BADGE:END -->
20<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="#backers-via-opencollective"><img alt="Open Collective backers" src="https://img.shields.io/opencollective/backers/getferdi?logo=open-collective"></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</p> 21</p>
23 22
24> 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. 23> 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones.
@@ -47,138 +46,7 @@ Ferdi is a desktop app that helps you organize how you use your favourite apps b
47 46
48Assets made available via [GitHub releases](https://github.com/getferdi/ferdi/releases/latest). 47Assets made available via [GitHub releases](https://github.com/getferdi/ferdi/releases/latest).
49 48
50## What makes Ferdi different from Franz? 49_Find answers to frequently asked questions on [getferdi.com/faq](https://getferdi.com/faq/)._
51
52_Find answers to other frequently asked questions on [getferdi.com/faq](https://getferdi.com/faq/)._
53
54<details>
55<summary>Toggle answer</summary>
56
57### Removes unproductive paywalls and other interruptions
58
59- [x] Removes the counter-productive fullscreen app delay inviting users to upgrade
60- [x] Removes pages begging you to donate after registration
61- [x] Removes "Franz is better together" popup
62- [x] Makes all users Premium by default ([#15](https://github.com/getferdi/ferdi/issues/15))
63
64### Adds features to increase your productivity
65
66- [x] Adds 30+ new services
67- [x] Adds "Find in Page" feature ([#67](https://github.com/getferdi/ferdi/issues/67))
68- [x] Adds an option to keep individual workspaces always loaded ([#37](https://github.com/getferdi/ferdi/issues/37))
69- [x] Adds "Quick Switch" feature to help you navigate a long list of services (similar to Rambox's [Quick Switcher](https://rambox.pro/#feature-details/quick_switcher))
70- [x] Adds "Service Hibernation" that will automatically unload services when they are unused to keep your computer running fast
71- [x] Adds a setting to keep service in hibernation after startup ([#577](https://github.com/getferdi/ferdi/issues/577), [#584](https://github.com/getferdi/ferdi/issues/584))
72- [x] [Add `user.css` and `user.js` that allows users to inject custom code into services](https://github.com/getferdi/ferdi/wiki/Using-user.css-and-user.js) ([#83](https://github.com/getferdi/ferdi/issues/83))
73- [x] Adds Process Manager to find services using a lot of resources
74- [x] Adds CTRL+← and CTRL+→ shortcuts and menu options to go back and forward in the service browsing history([#39](https://github.com/getferdi/ferdi/issues/39))
75- [x] Adds "Scheduled Do-not-Disturb" feature in which you won't get notifications (similar to Rambox's [Work Hours](https://rambox.pro/#feature-details/work_hours))
76- [x] Allows you to [use any Todo service inside "Franz Todo" panel](https://github.com/getferdi/ferdi/wiki/Custom-Todo) (e.g. Todoist via https://todoist.com/app) instead of being limited to using Franz Todo
77- [x] Adds a dropdown list to choose your Todo service ([#418](https://github.com/getferdi/ferdi/issues/418), [#477](https://github.com/getferdi/ferdi/issues/477)), 💖 [@yourcontact](https://github.com/yourcontact)
78- [x] Differentiates between indirect and direct notifications ([#590](https://github.com/getferdi/ferdi/issues/590)), 💖 [@Room4O4](https://github.com/Room4O4) [@mahadevans87](https://github.com/mahadevans87) [@FeikoJoosten](https://github.com/FeikoJoosten) [@sampathBlam](https://github.com/sampathBlam)
79
80### Adds features to improve your privacy
81
82- [x] [Adds option to change server to a custom](https://github.com/getferdi/ferdi/wiki/Custom-Server) [ferdi-server](https://github.com/getferdi/server)
83- [x] Adds option to use Ferdi without an account ([#5](https://github.com/getferdi/ferdi/issues/5))
84- [x] Uses the Ferdi API instead of Franz's servers
85- [x] Adds "Private Notification"-Mode, that hides message content from notifications ([franz#879](https://github.com/meetfranz/franz/issues/879))
86- [x] Adds Password Lock feature to keep your messages protected ([#41](https://github.com/getferdi/ferdi/issues/41), [franz#810](https://github.com/meetfranz/franz/issues/810), [franz#950](https://github.com/meetfranz/franz/issues/950), [franz#1430](https://github.com/meetfranz/franz/issues/1430))
87- [x] Adds support for unlocking with Touch ID ([#367](https://github.com/getferdi/ferdi/issues/367))
88- [x] Adds inactivity lock that automatically locks Ferdi after a specified amount of time ([#179](https://github.com/getferdi/ferdi/issues/179))
89- [x] Adds local [recipe repository](https://github.com/getferdi/recipes) that removes the need of downloading recipes from a remote server
90
91### Adds features to improve your experience using Ferdi
92
93- [x] Adds Universal Dark Mode via the [DarkReader extension](https://github.com/darkreader/darkreader) ([#71](https://github.com/getferdi/ferdi/issues/71))
94- [x] Adds Dark Reader settings ([#531](https://github.com/getferdi/ferdi/issues/531), [#568](https://github.com/getferdi/ferdi/issues/568)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87)
95- [x] Adds adaptable Dark Mode that will respect the system's Dark Mode setting ([#173](https://github.com/getferdi/ferdi/issues/173), [#548](https://github.com/getferdi/ferdi/issues/548) (💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87)))
96- [x] Adds a hotkey to quickly toggle darkmode ([#530](https://github.com/getferdi/ferdi/issues/530), [#537](https://github.com/getferdi/ferdi/issues/537)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87)
97- [x] Adds an option to start Ferdi minimized ([#490](https://github.com/getferdi/ferdi/issues/490), [#534](https://github.com/getferdi/ferdi/issues/534))
98- [x] Adds ability to change the services icons size and sidebar width ([#153](https://github.com/getferdi/ferdi/issues/153))
99- [x] Adds an option to auto-hide the menubar ([#7](https://github.com/getferdi/ferdi/issues/7), [franz#833](https://github.com/meetfranz/franz/issues/833))
100- [x] Enhances system tray icon behaviour ([#307](https://github.com/getferdi/ferdi/issues/307))
101- [x] Adds option to show draggable window area on macOS ([#304](https://github.com/getferdi/ferdi/issues/304), [#532](https://github.com/getferdi/ferdi/issues/532))
102- [x] Adds a notification & audio toggle action to the tray context menu ([#542](https://github.com/getferdi/ferdi/issues/542)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87)
103- [x] Adds option to show a browser-like navigation bar on all services
104- [x] Adds option to change accent color
105- [x] Reflects your currently opened service name to the window title to improve support for Password Managers ([#213](https://github.com/getferdi/ferdi/issues/213)), 💖 [@gmarec](https://github.com/gmarec)
106- [x] Allows using SVGs for service custom icon
107- [x] Adds button to open darkmode.css for a service
108- [x] Improves "About Ferdi" screen to better display versions
109- [x] Improves user onboarding ([#493](https://github.com/getferdi/ferdi/issues/493))
110- [x] Improves "Updates" section in settings ([#506](https://github.com/getferdi/ferdi/issues/506)), 💖 [@yourcontact](https://github.com/yourcontact)
111- [x] Improves draggable window area height for macOS ([#304](https://github.com/getferdi/ferdi/issues/304), [#479](https://github.com/getferdi/ferdi/issues/479))
112- [x] Adds option to start Ferdi in system tray ([#331](https://github.com/getferdi/ferdi/issues/331)), 💖 [@jereksel](https://github.com/jereksel)
113- [x] Fixes and enhances context menu ([#357](https://github.com/getferdi/ferdi/issues/357) [#413](https://github.com/getferdi/ferdi/issues/413) [#452](https://github.com/getferdi/ferdi/issues/452) [#354](https://github.com/getferdi/ferdi/issues/354) [#227](https://github.com/getferdi/ferdi/issues/227))
114- [x] Adds better support for macOS dark mode
115- [x] Adds option to disable reload of services after resuming Ferdi ([#442](https://github.com/getferdi/ferdi/issues/442)), 💖 [@n0emis](https://github.com/n0emis)
116- [x] Comes with a custom branding proper to Ferdi
117- [x] Adds better separation in settings
118- [x] Adds various other UI improvements
119- [x] Improves documentation of development so more developers can help making Ferdi even better
120- [x] Updates Microsoft Teams to allow Desktop Sharing ([getferdi/recipes#116](https://github.com/getferdi/recipes/issues/116)), 💖 [@Gautasmi](https://github.com/Gautasmi)
121- [x] Removes automatic reloading from WhatsApp
122
123### Fixes bugs
124
125- [x] Fixes bug that would incorrectly display unread messages count on some services (more info in [7566ccd](https://github.com/getferdi/ferdi/commit/7566ccd))
126- [x] Fixes zooming
127- [x] Fixes login problems in Google services
128- [x] Fixes missing Slack services custom icons ([#290](https://github.com/getferdi/ferdi/issues/290))
129- [x] Fixes bug that marked valid domains as invalid ([#276](https://github.com/getferdi/ferdi/issues/276))
130- [x] Fixes microphone/camera access on some versions of macOS ([#193](https://github.com/getferdi/ferdi/issues/193))
131- [x] Fixes cache clearing not working in Windows 10 ([#541](https://github.com/getferdi/ferdi/issues/541), [#544](https://github.com/getferdi/ferdi/issues/544)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87)
132- [x] Fixes Home button in navigation bar not correctly navigating ([#571](https://github.com/getferdi/ferdi/issues/571), [#573](https://github.com/getferdi/ferdi/issues/573)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87)
133- [x] Fixes notifications for various services, 💖 [@FeikoJoosten](https://github.com/FeikoJoosten)
134- [x] Refocuses Webview only for active service ([#610](https://github.com/getferdi/ferdi/issues/610)), 💖 [@Room4O4](https://github.com/Room4O4) & [@mahadevans87](https://github.com/mahadevans87)
135
136### Adds new platforms
137
138- [x] Adds portable version for Windows so you can use Ferdi without even installing it, 💖 [@Makazzz](https://github.com/Makazzz)
139- [x] Adds Arch Linux AUR packages, 💖 [@AGCaesar](https://github.com/AGCaesar)
140- [x] Adds Ferdi as a Flatpak on Flathub ([#323](https://github.com/getferdi/ferdi/issues/323)), 💖 [@lhw](https://github.com/lhw)
141
142### Adds internal changes
143
144- [x] Upgrades to Electron 15.3.4
145- [x] Switches to [`electron-spellchecker`](https://github.com/electron-userland/electron-spellchecker) to improve application size
146- [x] Minifies build files to improve app size
147- [x] Adds "npm run prepare-code" command for development to lint and beautify code
148- [x] Adds "npm run link-readme" command to automatically add links to issues and users inside README.md
149- [x] Fixes incorrect body closing tag ([#330](https://github.com/getferdi/ferdi/issues/330)), 💖 [@jereksel](https://github.com/jereksel)
150- [x] Uses CrowdIn to improve i18n
151- [x] Adds retry commands to flaky build steps ([#498](https://github.com/getferdi/ferdi/issues/498))
152- [x] Runs utility scripts pre-commit instead of pre-push ([#515](https://github.com/getferdi/ferdi/issues/515))
153
154</details>
155
156## Troubleshooting [recipes](https://github.com/getferdi/recipes)
157
158<details>
159<summary>Toggle answer</summary>
160
161One of the issues being raised by the users of Ferdi is that certain service-functionalities do not work. A 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
163Since 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.
164
165- 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- Stop Ferdi
167- Navigate to the Ferdi profile folder in your respective installation in your file explorer application.
168
169```bash
170 Mac: ~/Library/Application Support/Ferdi/recipes
171 Windows: %appdata%/Ferdi/recipes
172 Linux: ~/.config/Ferdi/recipes
173```
174
175- Delete the folder of the service that is causing your issue - _in the file explorer application_. (Please note that if you have manually modified any files here, it will be your responsibility to merge the changes with the latest version of the recipe (or you can submit a [pull request](https://github.com/getferdi/recipes/pulls) for the same).
176- Open a browser and navigate to the [recipes](https://github.com/getferdi/recipes/tree/master/recipes) repository page, and copy ALL the files for your erroneous service into your local machine at the location that you deleted in the previous step
177- Restart Ferdi (this should upgrade your recipes to the latest working version that the contributors have fixed)
178- If this process did not fix the issue, please log a detailed bug report [here](https://github.com/getferdi/recipes/issues)
179- _Note:_ An automated process to perform these steps is being ideated and tracked [here](https://github.com/getferdi/ferdi/issues/1302)
180
181</details>
182 50
183## Contributing 51## Contributing
184 52