aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Bennett <hello@vantezzen.io>2020-03-23 10:24:49 +0100
committerLibravatar GitHub <noreply@github.com>2020-03-23 10:24:49 +0100
commitb410ff3c69604f88dfe24f40fabf2b59982ed938 (patch)
treec0d99d6a4efbd8e770e8c9db378b9e5db4e56b00
parentNew Crowdin translations (#464) (diff)
downloadferdium-app-b410ff3c69604f88dfe24f40fabf2b59982ed938.tar.gz
ferdium-app-b410ff3c69604f88dfe24f40fabf2b59982ed938.tar.zst
ferdium-app-b410ff3c69604f88dfe24f40fabf2b59982ed938.zip
Improve feature list (#488)
* Improve feature list * Add general features section * Improve table of contents * Rephrasing * Unify feature list to use "-s" form * Fix missing rephrasing
-rw-r--r--README.md122
1 files changed, 84 insertions, 38 deletions
diff --git a/README.md b/README.md
index 78d2e8813..f9480bb4d 100644
--- a/README.md
+++ b/README.md
@@ -30,18 +30,14 @@
30- [Ferdi](#ferdi) 30- [Ferdi](#ferdi)
31 - [Table of contents](#table-of-contents) 31 - [Table of contents](#table-of-contents)
32 - [What is Ferdi?](#what-is-ferdi) 32 - [What is Ferdi?](#what-is-ferdi)
33 - [Features](#features)
33 - [What does Ferdi look like?](#what-does-ferdi-look-like) 34 - [What does Ferdi look like?](#what-does-ferdi-look-like)
34 - [Download Ferdi](#download-ferdi) 35 - [Download Ferdi](#download-ferdi)
35 - [Or use homebrew (macOS only)](#or-use-homebrew-macos-only) 36 - [Or use homebrew (macOS only)](#or-use-homebrew-macos-only)
36 - [Or use AUR (Arch Linux)](#or-use-aur-arch-linux) 37 - [Or use AUR (Arch Linux)](#or-use-aur-arch-linux)
37 - [Ferdi-specific Features](#ferdi-specific-features) 38 - [What makes Ferdi different from Franz?](#what-makes-ferdi-different-from-franz)
38 - [Development](#development) 39 - [Development](#development)
39 - [Install OS dependencies](#install-os-dependencies) 40 - [Install OS dependencies](#install-os-dependencies)
40 - [Node.js](#nodejs)
41 - [Git](#git)
42 - [Debian/Ubuntu](#debianubuntu)
43 - [Fedora](#fedora)
44 - [Windows](#windows)
45 - [Clone repository with submodule](#clone-repository-with-submodule) 41 - [Clone repository with submodule](#clone-repository-with-submodule)
46 - [Install dependencies](#install-dependencies) 42 - [Install dependencies](#install-dependencies)
47 - [Fix native modules to match current electron node version](#fix-native-modules-to-match-current-electron-node-version) 43 - [Fix native modules to match current electron node version](#fix-native-modules-to-match-current-electron-node-version)
@@ -57,6 +53,21 @@
57 53
58Ferdi is a messaging browser that allows you to combine your favorite messaging services into one application. It is based on Franz - a software already used by thousands of people - with the difference that Ferdi gives you many additonal features and doesn't restrict its usage! Ferdi is compatible with your existing Franz account so you can continue right where you left off. Find out more about Ferdi and its features on [getferdi.com](https://getferdi.com). 54Ferdi is a messaging browser that allows you to combine your favorite messaging services into one application. It is based on Franz - a software already used by thousands of people - with the difference that Ferdi gives you many additonal features and doesn't restrict its usage! Ferdi is compatible with your existing Franz account so you can continue right where you left off. Find out more about Ferdi and its features on [getferdi.com](https://getferdi.com).
59 55
56## Features
57- [x] Ferdi puts all your messaging services into one place
58- [x] Native support for 100+ services
59- [x] Workspaces to keep your personal and work life seperated
60- [x] Support for multiple accounts on any service
61- [x] Dark Mode support for all of your services
62- [x] Optional cloud sync to keep your services synchronized between devices
63- [x] Better control over when you get which notifications
64- [x] Cross-platform so you can view your services on all your computers
65- [x] Full proxy support to work in every network environment
66- [x] Ferdi speaks your language: Support for 20+ languages
67
68...and best of all:
69- [x] Its completely free! There are no restrictions on features, no paywalls
70
60### What does Ferdi look like? 71### What does Ferdi look like?
61 72
62<details> 73<details>
@@ -92,44 +103,79 @@ Ferdi has three seperate AUR packages you can use:
92 103
93If you use an AUR Helper e.g. yay, simply install it via `yay -S ferdi`. 104If you use an AUR Helper e.g. yay, simply install it via `yay -S ferdi`.
94 105
95## Ferdi-specific Features 106## What makes Ferdi different from Franz?
96 107
108### Removes unproductive paywalls and other other interruptions
97- [x] Removes the counter-productive fullscreen app delay inviting users to upgrade 109- [x] Removes the counter-productive fullscreen app delay inviting users to upgrade
98- [x] Removes pages begging you to donate after registration 110- [x] Removes pages begging you to donate after registration
99- [x] Remove "Franz is better together" popup 111- [x] Removes "Franz is better together" popup
100- [x] Remove bug that would incorrectly display unread messages count on some services (more info in [7566ccd](https://github.com/getferdi/ferdi/commit/7566ccd))
101- [x] Makes all users Premium by default ([#15](https://github.com/getferdi/ferdi/issues/15)) 112- [x] Makes all users Premium by default ([#15](https://github.com/getferdi/ferdi/issues/15))
102- [x] Using the Ferdi API instead of Franz's servers 113
103- [x] Upgrading to Electron 7 114### Adds features to increase your productivity
104- [x] Add several new services 115- [x] Adds 30+ new services
105- [x] [Add option to change server to a custom](https://github.com/getferdi/ferdi/wiki/Custom-Server) [ferdi-server](https://github.com/getferdi/server) 116- [x] Adds "Find in Page" feature ([#67](https://github.com/getferdi/ferdi/issues/67))
106- [x] Add option to use Ferdi without an account ([#5](https://github.com/getferdi/ferdi/issues/5)) 117- [x] Adds an option to keep individual workspaces always loaded ([#37](https://github.com/getferdi/ferdi/issues/37))
107- [x] Add "Private Notification"-Mode, that hides message content from notifications ([franz#879](https://github.com/meetfranz/franz/issues/879)) 118- [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))
108- [x] Add 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)) 119- [x] Adds "Service Hibernation" that will automatically unload services when they are unused to keep your computer running fast
109- [x] Add an option to keep individual workspaces always loaded ([#37](https://github.com/getferdi/ferdi/issues/37))
110- [x] Add Universal Dark Mode via the [DarkReader extension](https://github.com/darkreader/darkreader) ([#71](https://github.com/getferdi/ferdi/issues/71))
111- [x] Add adaptable Dark Mode that will respect the system's Dark Mode setting ([#173](https://github.com/getferdi/ferdi/issues/173))
112- [x] Add an option to auto-hide the menubar ([#7](https://github.com/getferdi/ferdi/issues/7), [franz#833](https://github.com/meetfranz/franz/issues/833))
113- [x] Add "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))
114- [x] Add "Service Hibernation" that will automatically unload services when they are unused
115- [x] Add "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))
116- [x] Add 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))
117- [x] Add option to show a browser-like navigation bar on all services
118- [x] Add option to change accent color
119- [x] Add local [recipe repository](https://github.com/getferdi/recipes) that removes the need of downloading recipes from a remote server
120- [x] Add portable version for Windows
121- [x] Add Process Manager to find services using a lot of resources
122- [x] Add "npm run prepare-code" command for development to lint and beautify code
123- [x] Add button to open darkmode.css for a service
124- [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)) 120- [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))
125- [x] Allow SVGs for service custom icon 121- [x] Adds Process Manager to find services using a lot of resources
126- [x] Switch to [`electron-spellchecker`](https://github.com/electron-userland/electron-spellchecker) to improve application size 122- [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))
127- [x] Improve "About Ferdi" screen to better display versions 123- [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))
128- [x] Minifying build files to improve app size 124- [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
129- [x] [Makes it possible to edit the "Franz Todos" service](https://github.com/getferdi/ferdi/wiki/Custom-Todo) (e.g. Todoist via https://todoist.com/app) 125
130- [x] Makes RocketChat self-hosted generally available ([#6](https://github.com/getferdi/ferdi/issues/6)) 126### Adds features to improve your privacy
127- [x] [Adds option to change server to a custom](https://github.com/getferdi/ferdi/wiki/Custom-Server) [ferdi-server](https://github.com/getferdi/server)
128- [x] Adds option to use Ferdi without an account ([#5](https://github.com/getferdi/ferdi/issues/5))
129- [x] Uses the Ferdi API instead of Franz's servers
130- [x] Adds "Private Notification"-Mode, that hides message content from notifications ([franz#879](https://github.com/meetfranz/franz/issues/879))
131- [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))
132- [x] Adds support for unlocking with Touch ID ([#367](https://github.com/getferdi/ferdi/issues/367))
133- [x] Adds inactivity lock that automatically locks Ferdi after a specified amount of time ([#179](https://github.com/getferdi/ferdi/issues/179))
134- [x] Adds local [recipe repository](https://github.com/getferdi/recipes) that removes the need of downloading recipes from a remote server
135
136### Adds features to improve your experience using Ferdi
137- [x] Adds Universal Dark Mode via the [DarkReader extension](https://github.com/darkreader/darkreader) ([#71](https://github.com/getferdi/ferdi/issues/71))
138- [x] Adds adaptable Dark Mode that will respect the system's Dark Mode setting ([#173](https://github.com/getferdi/ferdi/issues/173))
139- [x] Adds ability to change the services icons size and sidebar width ([#153](https://github.com/getferdi/ferdi/issues/153))
140- [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))
141- [x] Enhances system tray icon behaviour ([#307](https://github.com/getferdi/ferdi/issues/307))
142- [x] Adds option to show a browser-like navigation bar on all services
143- [x] Adds option to change accent color
144- [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))
145- [x] Allows using SVGs for service custom icon
146- [x] Adds button to open darkmode.css for a service
147- [x] Improves "About Ferdi" screen to better display versions
148- [x] Adds option to start Ferdi in system tray ([#331](https://github.com/getferdi/ferdi/issues/331))
149- [x] Fixes and enhances context menu (#357 #413 #452 #354 #227)
150- [x] Adds better support for macOS dark mode
151- [x] Adds option to disable reload of services after resuming Ferdi ([#442](https://github.com/getferdi/ferdi/issues/442))
131- [x] Comes with a custom branding proper to Ferdi 152- [x] Comes with a custom branding proper to Ferdi
132- [x] UI improvements 153- [x] Adds better seperation in settings
154- [x] Adds various other UI improvements
155- [x] Improves documentation of development so more developers can help making Ferdi even better
156
157### Removed bugs
158- [x] Fixes bug that would incorrectly display unread messages count on some services (more info in [7566ccd](https://github.com/getferdi/ferdi/commit/7566ccd))
159- [x] Fixes zooming
160- [x] Fixes login problems in Google services
161- [x] Fixes missing Slack services custom icons ([#290](https://github.com/getferdi/ferdi/issues/290))
162- [x] Fixes bug that marked valid domains as invalid ([#276](https://github.com/getferdi/ferdi/issues/276))
163- [x] Fixes microphone/camera access on some versions of macOS ([#193](https://github.com/getferdi/ferdi/issues/193))
164
165### Adds new platforms
166- [x] Adds portable version for Windows so you can use Ferdi without even installing it
167- [x] Adds Arch Linux AUR packages
168- [x] Adds Ferdi as a Flatpak on Flathub ([#323](https://github.com/getferdi/ferdi/issues/323))
169
170### Adds internal changes
171- [x] Upgrades to Electron 8
172- [x] Switches to [`electron-spellchecker`](https://github.com/electron-userland/electron-spellchecker) to improve application size
173- [x] Minifies build files to improve app size
174- [x] Adds "npm run prepare-code" command for development to lint and beautify code
175- [x] Fixes incorrect body closing tag ([#330](https://github.com/getferdi/ferdi/issues/330))
176- [x] Uses CrowdIn to improve i18n
177
178> Thanks to all our [contributors](#contributors-) who helped realize all these amazing features! 💖
133 179
134## Development 180## Development
135 181