Merge pull request #17 from vantezzen/master

Remove analytics, custom server support, custom branding and more

1 files changed, 70 insertions, 8 deletions

diff --git a/README.md b/README.md
index 54c47a959..0fa7cc25b 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,28 @@
-<img src="./build-helpers/images/icon.png" alt="" width="150"/>
+<p align="center">
+    <img src="./build-helpers/images/icon.png" alt="" width="200"/>
+</p>
 
-# Ferdi
+# Ferdi 
+
+👛 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted features.
+
+## Features
+- [x] Removes the fullscreen app delay inviting users to upgrade
+- [x] Removes pages begging you to donate after registration
+- [x] Makes all users premium
+- [x] [Add option to change server to a custom](#servers) [ferdi-server](https://github.com/vantezzen/ferdi-server)
+- [x] Remove "Franz is better together"(shareFranz) popup
+- [x] Custom branding
+- [ ] [#5](https://github.com/kytwb/Ferdi/issues/5) Makes it optional to create an account
+- [ ] [#6](https://github.com/kytwb/Ferdi/issues/6) Makes RocketChat self-hosted generally available
+
+## 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.
+
+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.
+
+More information on how to set up a ferdi-server can be found at <https://github.com/vantezzen/ferdi-server/blob/master/README.md>.
 
-👛 Hard-fork of [Franz](https://github.com/meetfranz/franz) removing the non-skippable app delay (too) frequently inviting you to buy a licence
 
 ## Packaging
 
@@ -13,12 +33,54 @@ $ npm run build
 
 Deliverables will be available in the `./out` folder.
 
+## Developing
+### Preparations
+- [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)
+
+### 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.
+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.
 
-## Features
+## Contributors ✨
 
-- [x] Removes the fullscreen app delay inviting users to upgrade
-- [ ] [#5](https://github.com/kytwb/ferdi/issues/5) Makes it optional to create an account
-- [ ] [#6](https://github.com/kytwb/ferdi/issues/6) Makes RocketChat self-hosted generally available
+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!
\ No newline at end of file