aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar vantezzen <properly@protonmail.com>2019-08-28 13:14:20 +0200
committerLibravatar vantezzen <properly@protonmail.com>2019-08-28 13:14:20 +0200
commitfeab644f4f1dd91372616787451ceadcf81b3a69 (patch)
treec1a844ddda38fc51cc63c4a17d6f5986a51bec0b /README.md
parentLint (diff)
downloadferdium-app-feab644f4f1dd91372616787451ceadcf81b3a69.tar.gz
ferdium-app-feab644f4f1dd91372616787451ceadcf81b3a69.tar.zst
ferdium-app-feab644f4f1dd91372616787451ceadcf81b3a69.zip
Add server information to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1a565eec1..2db4d5fd6 100644
--- a/README.md
+++ b/README.md
@@ -8,12 +8,20 @@
8- [x] Removes the fullscreen app delay inviting users to upgrade 8- [x] Removes the fullscreen app delay inviting users to upgrade
9- [x] Removes pages begging you to donate after registration 9- [x] Removes pages begging you to donate after registration
10- [x] Makes all users premium 10- [x] Makes all users premium
11- [x] Add option to change server to a custom [ferdi-server](https://github.com/vantezzen/ferdi-server) 11- [x] [Add option to change server to a custom](#servers) [ferdi-server](https://github.com/vantezzen/ferdi-server)
12- [x] Remove "Franz is better together"(shareFranz) popup 12- [x] Remove "Franz is better together"(shareFranz) popup
13- [x] Custom branding 13- [x] Custom branding
14- [ ] [#5](https://github.com/kytwb/Ferdi/issues/5) Makes it optional to create an account 14- [ ] [#5](https://github.com/kytwb/Ferdi/issues/5) Makes it optional to create an account
15- [ ] [#6](https://github.com/kytwb/Ferdi/issues/6) Makes RocketChat self-hosted generally available 15- [ ] [#6](https://github.com/kytwb/Ferdi/issues/6) Makes RocketChat self-hosted generally available
16 16
17## Servers
18Ferdi 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.
19
20If 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.
21
22More information on how to set up a ferdi-server can be found at <https://github.com/vantezzen/ferdi-server/blob/master/README.md>.
23
24
17## Packaging 25## Packaging
18 26
19```bash 27```bash