1 files changed, 76 insertions, 47 deletions
diff --git a/README.md b/README.md
index 5397189c6..c4f3f7554 100644
--- a/README.md
+++ b/README.md
@@ -1,63 +1,92 @@
-<img src="./build-helpers/images/icon.png" alt="" width="150"/>
+<p align="center">
+    <img src="./build-helpers/images/icon.png" alt="" width="200"/>
+</p>
-# Franz 5
+# Ferdi 
-[![Build status Windows](https://ci.appveyor.com/api/projects/status/9yman4ye19x4274o/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master)
- [![Build Status Mac & Linux](https://travis-ci.com/meetfranz/franz.svg?branch=master)](https://travis-ci.com/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://meetfranz.com/payment.html)
-Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more.
+🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted features.
-## [Download Franz](https://www.meetfranz.com)
+## Features
-👉 www.meetfranz.com
+- [x] Removes the counter-productive fullscreen app delay inviting users to upgrade
+- [x] Removes pages begging you to donate after registration
+- [x] Makes all users Premium by default
+- [x] [Add option to change server to a custom](#servers) [ferdi-server](https://github.com/vantezzen/ferdi-server)
+- [x] Remove "Franz is better together" popup
+- [x] [Makes it possible to edit the "Franz Todo" server](#franz-todo)
+- [x] Makes RocketChat self-hosted generally available
+- [x] Comes with a custom branding proper to Ferdi
-### Or use homebrew (macOS only)
+### Servers
+Ferdi adds the option to change your Ferdi server. By default, this will be `https://api.franzinfra.com` - the official Franz server. This allows Ferdi to stay compatible with your current Franz account.
-`$ brew cask install franz`
+If you want to experience all Ferdi features, you may want to use a custom [ferdi-server](https://github.com/vantezzen/ferdi-server). ferdi-server allows you to use Premium features without restrictions and adds the ability to package and add additional recipes. You can also import your existing Franz account into your ferdi-server to start right where you left off.
-(Don't know homebrew? [brew.sh](https://brew.sh/))
+More information on how to set up a ferdi-server can be found at <https://github.com/vantezzen/ferdi-server/blob/master/README.md>.
-## Development
+### Franz Todo
+Starting with Franz 5.3.0, Franz ships with the "Franz Todo" feature. This feature allows you to create a Franz Todo list that stays open at all times.
-### Preparations
+Ferdi makes it possible to change the Franz Todo list server to any URL you want, e.g. to `todoist.com` to use your Todoist todo list in Franz todo.
-#### Install Linux OS dependencies
-[Guide: Linux distribution specific dependencies](docs/linux.md)
-#### Fix native modules to match current electron node version
-```bash
-$ npm run rebuild
-```
-### Install dependencies
-Run the following command to install all dependencies, and link sibling modules with Franz.
-```bash
-$ npx lerna bootstrap
-```
-If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. 
+![Todoist in Franz Todo](screenshots/Ferdi-Todo.png)
-### Run Franz Development App
-Run these two commands __simultaneously__ in different console tabs.
-```bash
-$ npm run dev
-$ npm run start
-```
-Be aware that the development database will be reset regularly.
 ## Packaging
 ```bash
+$ npm install
 $ npm run build
 ```
-## How can I support the project?
+Deliverables will be available in the `./out` folder.
-If you have found a bug that hasn't been reported yet or want to request a new feature, please open a new issue.
-## I need help?
-Join the Franz community on [Slack](http://slack.franz.im) and get in touch with us.
-## Create your own plugins/recipes
+## Developing
-You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins).
+### Preparations
-For questions feel free to ask in the [community Slack](http://slack.franz.im)
+- [Install Linux dependencies](docs/linux.md) if you are developing on Linux
+- Make sure you are running NodeJS v10. Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278)
-## License
-Franz 5 is open-source licensed under the Apache-2.0 License.
+### Setup
+1. Fix native modules to match current electron node version
+    ```
+    npm run rebuild
+    ```
+2. Install dependencies using lerna
+    ```
+    npx lerna bootstrap
+    ```
+3. Run Ferdi Development App
+    Run these two commands *simultaneously* in different console tabs.
+    ```
+    npm run dev
+    npm run start
+    ```
+## Releases
+You can find the binaries for Linux, MacOS and Windows in the [latest release](https://github.com/kytwb/Ferdi/releases/tag/Ferdi-5.2.0-beta.3) assets. Assets are continuously delivered through [Travis](https://travis-ci.org/kytwb/Ferdi) for Linux/MacOS and [Appveyor](https://ci.appveyor.com/project/kytwb/Ferdi) for Windows.
+## Contributors ✨
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://twitter.com/kytwb"><img src="https://avatars0.githubusercontent.com/u/412895?v=4" width="100px;" alt="Amine Mouafik"/><br /><sub><b>Amine Mouafik</b></sub></a><br /><a href="#question-kytwb" title="Answering Questions">💬</a> <a href="https://github.com/kytwb/ferdi/commits?author=kytwb" title="Code">💻</a> <a href="https://github.com/kytwb/ferdi/commits?author=kytwb" title="Documentation">📖</a> <a href="#ideas-kytwb" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-kytwb" title="Maintenance">🚧</a> <a href="#platform-kytwb" title="Packaging/porting to new platform">📦</a> <a href="#projectManagement-kytwb" title="Project Management">📆</a> <a href="#review-kytwb" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://vantezzen.io"><img src="https://avatars2.githubusercontent.com/u/10333196?v=4" width="100px;" alt="Bennett"/><br /><sub><b>Bennett</b></sub></a><br /><a href="https://github.com/kytwb/ferdi/commits?author=vantezzen" title="Code">💻</a> <a href="#design-vantezzen" title="Design">🎨</a> <a href="https://github.com/kytwb/ferdi/commits?author=vantezzen" title="Documentation">📖</a> <a href="#ideas-vantezzen" title="Ideas, Planning, & Feedback">🤔</a> <a href="#translation-vantezzen" title="Translation">🌍</a></td>
+    <td align="center"><a href="http://www.adlk.io"><img src="https://avatars1.githubusercontent.com/u/3265004?v=4" width="100px;" alt="Stefan Malzner"/><br /><sub><b>Stefan Malzner</b></sub></a><br /><a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Code">💻</a> <a href="#content-adlk" title="Content">🖋</a> <a href="#design-adlk" title="Design">🎨</a> <a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Documentation">📖</a> <a href="#ideas-adlk" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-adlk" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#projectManagement-adlk" title="Project Management">📆</a> <a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Tests">⚠️</a> <a href="#translation-adlk" title="Translation">🌍</a></td>
+  </tr>
+</table>
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

diff --git a/README.md b/README.md index 5397189c6..c4f3f7554 100644 --- a/README.md +++ b/README.md
@@ -1,63 +1,92 @@
1	<img src="./build-helpers/images/icon.png" alt="" width="150"/>	1	<p align="center">
		2	<img src="./build-helpers/images/icon.png" alt="" width="200"/>
		3	</p>
2		4
3	# Franz 5	5	# Ferdi
4	[![Build status Windows](https://ci.appveyor.com/api/projects/status/9yman4ye19x4274o/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master)
5	[![Build Status Mac & Linux](https://travis-ci.com/meetfranz/franz.svg?branch=master)](https://travis-ci.com/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://meetfranz.com/payment.html)
6		6
7	Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more.	7	🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted features.
8		8
9	## [Download Franz](https://www.meetfranz.com)	9	## Features
10	👉 www.meetfranz.com	10	- [x] Removes the counter-productive fullscreen app delay inviting users to upgrade
		11	- [x] Removes pages begging you to donate after registration
		12	- [x] Makes all users Premium by default
		13	- [x] [Add option to change server to a custom](#servers) [ferdi-server](https://github.com/vantezzen/ferdi-server)
		14	- [x] Remove "Franz is better together" popup
		15	- [x] [Makes it possible to edit the "Franz Todo" server](#franz-todo)
		16	- [x] Makes RocketChat self-hosted generally available
		17	- [x] Comes with a custom branding proper to Ferdi
11		18
12	### Or use homebrew (macOS only)	19	### Servers
		20	Ferdi adds the option to change your Ferdi server. By default, this will be `https://api.franzinfra.com` - the official Franz server. This allows Ferdi to stay compatible with your current Franz account.
13		21
14	`$ brew cask install franz`	22	If you want to experience all Ferdi features, you may want to use a custom [ferdi-server](https://github.com/vantezzen/ferdi-server). ferdi-server allows you to use Premium features without restrictions and adds the ability to package and add additional recipes. You can also import your existing Franz account into your ferdi-server to start right where you left off.
15		23
16	(Don't know homebrew? [brew.sh](https://brew.sh/))	24	More information on how to set up a ferdi-server can be found at <https://github.com/vantezzen/ferdi-server/blob/master/README.md>.
17		25
18	## Development	26	### Franz Todo
		27	Starting with Franz 5.3.0, Franz ships with the "Franz Todo" feature. This feature allows you to create a Franz Todo list that stays open at all times.
19		28
20	### Preparations	29	Ferdi makes it possible to change the Franz Todo list server to any URL you want, e.g. to `todoist.com` to use your Todoist todo list in Franz todo.
21
22	#### Install Linux OS dependencies
23	[Guide: Linux distribution specific dependencies](docs/linux.md)
24
25	#### Fix native modules to match current electron node version
26	```bash
27	$ npm run rebuild
28	```
29
30	### Install dependencies
31	Run the following command to install all dependencies, and link sibling modules with Franz.
32	```bash
33	$ npx lerna bootstrap
34	```
35		30
36	If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`.	31	![Todoist in Franz Todo](screenshots/Ferdi-Todo.png)
37
38	### Run Franz Development App
39	Run these two commands __simultaneously__ in different console tabs.
40
41	```bash
42	$ npm run dev
43	$ npm run start
44	```
45	Be aware that the development database will be reset regularly.
46		32
47	## Packaging	33	## Packaging
		34
48	```bash	35	```bash
		36	$ npm install
49	$ npm run build	37	$ npm run build
50	```	38	```
51		39
52	## How can I support the project?	40	Deliverables will be available in the `./out` folder.
53	If you have found a bug that hasn't been reported yet or want to request a new feature, please open a new issue.
54
55	## I need help?
56	Join the Franz community on [Slack](http://slack.franz.im) and get in touch with us.
57		41
58	## Create your own plugins/recipes	42	## Developing
59	You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins).	43	### Preparations
60	For questions feel free to ask in the [community Slack](http://slack.franz.im)	44	- [Install Linux dependencies](docs/linux.md) if you are developing on Linux
61		45	- Make sure you are running NodeJS v10. Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278)
62	## License	46
63	Franz 5 is open-source licensed under the Apache-2.0 License.	47	### Setup
		48	1. Fix native modules to match current electron node version
		49	```
		50	npm run rebuild
		51	```
		52	2. Install dependencies using lerna
		53	```
		54	npx lerna bootstrap
		55	```
		56	3. Run Ferdi Development App
		57	Run these two commands simultaneously in different console tabs.
		58	```
		59	npm run dev
		60	npm run start
		61	```
		62
		63	## Releases
		64
		65	You can find the binaries for Linux, MacOS and Windows in the [latest release](https://github.com/kytwb/Ferdi/releases/tag/Ferdi-5.2.0-beta.3) assets. Assets are continuously delivered through [Travis](https://travis-ci.org/kytwb/Ferdi) for Linux/MacOS and [Appveyor](https://ci.appveyor.com/project/kytwb/Ferdi) for Windows.
		66
		67	## Contributors ✨
		68
		69	Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
		70	<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
		71	<!-- prettier-ignore-start -->
		72	<!-- markdownlint-disable -->
		73	<table>
		74	<tr>
		75	<td align="center"><a href="https://twitter.com/kytwb"><img src="https://avatars0.githubusercontent.com/u/412895?v=4" width="100px;" alt="Amine Mouafik"/><br /><sub><b>Amine Mouafik</b></sub></a><br /><a href="#question-kytwb" title="Answering Questions">💬</a> <a href="https://github.com/kytwb/ferdi/commits?author=kytwb" title="Code">💻</a> <a href="https://github.com/kytwb/ferdi/commits?author=kytwb" title="Documentation">📖</a> <a href="#ideas-kytwb" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-kytwb" title="Maintenance">🚧</a> <a href="#platform-kytwb" title="Packaging/porting to new platform">📦</a> <a href="#projectManagement-kytwb" title="Project Management">📆</a> <a href="#review-kytwb" title="Reviewed Pull Requests">👀</a></td>
		76	<td align="center"><a href="https://vantezzen.io"><img src="https://avatars2.githubusercontent.com/u/10333196?v=4" width="100px;" alt="Bennett"/><br /><sub><b>Bennett</b></sub></a><br /><a href="https://github.com/kytwb/ferdi/commits?author=vantezzen" title="Code">💻</a> <a href="#design-vantezzen" title="Design">🎨</a> <a href="https://github.com/kytwb/ferdi/commits?author=vantezzen" title="Documentation">📖</a> <a href="#ideas-vantezzen" title="Ideas, Planning, & Feedback">🤔</a> <a href="#translation-vantezzen" title="Translation">🌍</a></td>
		77	<td align="center"><a href="http://www.adlk.io"><img src="https://avatars1.githubusercontent.com/u/3265004?v=4" width="100px;" alt="Stefan Malzner"/><br /><sub><b>Stefan Malzner</b></sub></a><br /><a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Code">💻</a> <a href="#content-adlk" title="Content">🖋</a> <a href="#design-adlk" title="Design">🎨</a> <a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Documentation">📖</a> <a href="#ideas-adlk" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-adlk" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#projectManagement-adlk" title="Project Management">📆</a> <a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Tests">⚠️</a> <a href="#translation-adlk" title="Translation">🌍</a></td>
		78	</tr>
		79	</table>
		80
		81	<!-- markdownlint-enable -->
		82	<!-- prettier-ignore-end -->
		83	<!-- ALL-CONTRIBUTORS-LIST:END -->
		84
		85	<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
		86	<!-- prettier-ignore-start -->
		87	<!-- markdownlint-disable -->
		88	<!-- markdownlint-enable -->
		89	<!-- prettier-ignore-end -->
		90	<!-- ALL-CONTRIBUTORS-LIST:END -->
		91
		92	This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!