From b410ff3c69604f88dfe24f40fabf2b59982ed938 Mon Sep 17 00:00:00 2001 From: Bennett Date: Mon, 23 Mar 2020 10:24:49 +0100 Subject: 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 --- README.md | 122 ++++++++++++++++++++++++++++++++++++++++++-------------------- 1 file 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 @@ - [Ferdi](#ferdi) - [Table of contents](#table-of-contents) - [What is Ferdi?](#what-is-ferdi) + - [Features](#features) - [What does Ferdi look like?](#what-does-ferdi-look-like) - [Download Ferdi](#download-ferdi) - [Or use homebrew (macOS only)](#or-use-homebrew-macos-only) - [Or use AUR (Arch Linux)](#or-use-aur-arch-linux) - - [Ferdi-specific Features](#ferdi-specific-features) + - [What makes Ferdi different from Franz?](#what-makes-ferdi-different-from-franz) - [Development](#development) - [Install OS dependencies](#install-os-dependencies) - - [Node.js](#nodejs) - - [Git](#git) - - [Debian/Ubuntu](#debianubuntu) - - [Fedora](#fedora) - - [Windows](#windows) - [Clone repository with submodule](#clone-repository-with-submodule) - [Install dependencies](#install-dependencies) - [Fix native modules to match current electron node version](#fix-native-modules-to-match-current-electron-node-version) @@ -57,6 +53,21 @@ Ferdi 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). +## Features +- [x] Ferdi puts all your messaging services into one place +- [x] Native support for 100+ services +- [x] Workspaces to keep your personal and work life seperated +- [x] Support for multiple accounts on any service +- [x] Dark Mode support for all of your services +- [x] Optional cloud sync to keep your services synchronized between devices +- [x] Better control over when you get which notifications +- [x] Cross-platform so you can view your services on all your computers +- [x] Full proxy support to work in every network environment +- [x] Ferdi speaks your language: Support for 20+ languages + +...and best of all: +- [x] Its completely free! There are no restrictions on features, no paywalls + ### What does Ferdi look like?
@@ -92,44 +103,79 @@ Ferdi has three seperate AUR packages you can use: If you use an AUR Helper e.g. yay, simply install it via `yay -S ferdi`. -## Ferdi-specific Features +## What makes Ferdi different from Franz? +### Removes unproductive paywalls and other other interruptions - [x] Removes the counter-productive fullscreen app delay inviting users to upgrade - [x] Removes pages begging you to donate after registration -- [x] Remove "Franz is better together" popup -- [x] Remove bug that would incorrectly display unread messages count on some services (more info in [7566ccd](https://github.com/getferdi/ferdi/commit/7566ccd)) +- [x] Removes "Franz is better together" popup - [x] Makes all users Premium by default ([#15](https://github.com/getferdi/ferdi/issues/15)) -- [x] Using the Ferdi API instead of Franz's servers -- [x] Upgrading to Electron 7 -- [x] Add several new services -- [x] [Add option to change server to a custom](https://github.com/getferdi/ferdi/wiki/Custom-Server) [ferdi-server](https://github.com/getferdi/server) -- [x] Add option to use Ferdi without an account ([#5](https://github.com/getferdi/ferdi/issues/5)) -- [x] Add "Private Notification"-Mode, that hides message content from notifications ([franz#879](https://github.com/meetfranz/franz/issues/879)) -- [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)) -- [x] Add an option to keep individual workspaces always loaded ([#37](https://github.com/getferdi/ferdi/issues/37)) -- [x] Add Universal Dark Mode via the [DarkReader extension](https://github.com/darkreader/darkreader) ([#71](https://github.com/getferdi/ferdi/issues/71)) -- [x] Add adaptable Dark Mode that will respect the system's Dark Mode setting ([#173](https://github.com/getferdi/ferdi/issues/173)) -- [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)) -- [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)) -- [x] Add "Service Hibernation" that will automatically unload services when they are unused -- [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)) -- [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)) -- [x] Add option to show a browser-like navigation bar on all services -- [x] Add option to change accent color -- [x] Add local [recipe repository](https://github.com/getferdi/recipes) that removes the need of downloading recipes from a remote server -- [x] Add portable version for Windows -- [x] Add Process Manager to find services using a lot of resources -- [x] Add "npm run prepare-code" command for development to lint and beautify code -- [x] Add button to open darkmode.css for a service + +### Adds features to increase your productivity +- [x] Adds 30+ new services +- [x] Adds "Find in Page" feature ([#67](https://github.com/getferdi/ferdi/issues/67)) +- [x] Adds an option to keep individual workspaces always loaded ([#37](https://github.com/getferdi/ferdi/issues/37)) +- [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)) +- [x] Adds "Service Hibernation" that will automatically unload services when they are unused to keep your computer running fast - [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)) -- [x] Allow SVGs for service custom icon -- [x] Switch to [`electron-spellchecker`](https://github.com/electron-userland/electron-spellchecker) to improve application size -- [x] Improve "About Ferdi" screen to better display versions -- [x] Minifying build files to improve app size -- [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) -- [x] Makes RocketChat self-hosted generally available ([#6](https://github.com/getferdi/ferdi/issues/6)) +- [x] Adds Process Manager to find services using a lot of resources +- [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)) +- [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)) +- [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 + +### Adds features to improve your privacy +- [x] [Adds option to change server to a custom](https://github.com/getferdi/ferdi/wiki/Custom-Server) [ferdi-server](https://github.com/getferdi/server) +- [x] Adds option to use Ferdi without an account ([#5](https://github.com/getferdi/ferdi/issues/5)) +- [x] Uses the Ferdi API instead of Franz's servers +- [x] Adds "Private Notification"-Mode, that hides message content from notifications ([franz#879](https://github.com/meetfranz/franz/issues/879)) +- [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)) +- [x] Adds support for unlocking with Touch ID ([#367](https://github.com/getferdi/ferdi/issues/367)) +- [x] Adds inactivity lock that automatically locks Ferdi after a specified amount of time ([#179](https://github.com/getferdi/ferdi/issues/179)) +- [x] Adds local [recipe repository](https://github.com/getferdi/recipes) that removes the need of downloading recipes from a remote server + +### Adds features to improve your experience using Ferdi +- [x] Adds Universal Dark Mode via the [DarkReader extension](https://github.com/darkreader/darkreader) ([#71](https://github.com/getferdi/ferdi/issues/71)) +- [x] Adds adaptable Dark Mode that will respect the system's Dark Mode setting ([#173](https://github.com/getferdi/ferdi/issues/173)) +- [x] Adds ability to change the services icons size and sidebar width ([#153](https://github.com/getferdi/ferdi/issues/153)) +- [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)) +- [x] Enhances system tray icon behaviour ([#307](https://github.com/getferdi/ferdi/issues/307)) +- [x] Adds option to show a browser-like navigation bar on all services +- [x] Adds option to change accent color +- [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)) +- [x] Allows using SVGs for service custom icon +- [x] Adds button to open darkmode.css for a service +- [x] Improves "About Ferdi" screen to better display versions +- [x] Adds option to start Ferdi in system tray ([#331](https://github.com/getferdi/ferdi/issues/331)) +- [x] Fixes and enhances context menu (#357 #413 #452 #354 #227) +- [x] Adds better support for macOS dark mode +- [x] Adds option to disable reload of services after resuming Ferdi ([#442](https://github.com/getferdi/ferdi/issues/442)) - [x] Comes with a custom branding proper to Ferdi -- [x] UI improvements +- [x] Adds better seperation in settings +- [x] Adds various other UI improvements +- [x] Improves documentation of development so more developers can help making Ferdi even better + +### Removed bugs +- [x] Fixes bug that would incorrectly display unread messages count on some services (more info in [7566ccd](https://github.com/getferdi/ferdi/commit/7566ccd)) +- [x] Fixes zooming +- [x] Fixes login problems in Google services +- [x] Fixes missing Slack services custom icons ([#290](https://github.com/getferdi/ferdi/issues/290)) +- [x] Fixes bug that marked valid domains as invalid ([#276](https://github.com/getferdi/ferdi/issues/276)) +- [x] Fixes microphone/camera access on some versions of macOS ([#193](https://github.com/getferdi/ferdi/issues/193)) + +### Adds new platforms +- [x] Adds portable version for Windows so you can use Ferdi without even installing it +- [x] Adds Arch Linux AUR packages +- [x] Adds Ferdi as a Flatpak on Flathub ([#323](https://github.com/getferdi/ferdi/issues/323)) + +### Adds internal changes +- [x] Upgrades to Electron 8 +- [x] Switches to [`electron-spellchecker`](https://github.com/electron-userland/electron-spellchecker) to improve application size +- [x] Minifies build files to improve app size +- [x] Adds "npm run prepare-code" command for development to lint and beautify code +- [x] Fixes incorrect body closing tag ([#330](https://github.com/getferdi/ferdi/issues/330)) +- [x] Uses CrowdIn to improve i18n + +> Thanks to all our [contributors](#contributors-) who helped realize all these amazing features! 💖 ## Development -- cgit v1.2.3-70-g09d2