diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 6 |
1 files changed, 4 insertions, 2 deletions
@@ -6,8 +6,7 @@ | |||
6 | Unofficial Franz server replacement for use with the Ferdi Client. | 6 | Unofficial Franz server replacement for use with the Ferdi Client. |
7 | 7 | ||
8 | ## Why use a custom ferdi-server? | 8 | ## Why use a custom ferdi-server? |
9 | A custom ferdi-server allows you to experience the full potential of the Ferdi client. | 9 | A custom ferdi-server allows you to experience the full potential of the Ferdi client. It allows you to use all Premium features (e.g. Workspaces and custom URL recipes) and [adding your own recipes](#creating-and-using-custom-recipes). |
10 | |||
11 | 10 | ||
12 | ## Features | 11 | ## Features |
13 | - [x] User registration and login | 12 | - [x] User registration and login |
@@ -52,5 +51,8 @@ To add your recipe to ferdi-server, open `http://[YOUR FERDI-SERVER]/new` in you | |||
52 | - `Link to PNG/SVG image`: Direct link to a 1024x1024 PNG image and SVG that is used as a logo inside the store. Please use jsDelivr when using a file uploaded to GitHub as raw.githubusercontent files won't load | 51 | - `Link to PNG/SVG image`: Direct link to a 1024x1024 PNG image and SVG that is used as a logo inside the store. Please use jsDelivr when using a file uploaded to GitHub as raw.githubusercontent files won't load |
53 | - `Recipe files`: Recipe files that you created using the [Franz recipe creation guide](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). Please do *not* package your files beforehand - upload the raw files (you can drag and drop multiple files). ferdi-server will automatically package and store the recipe in the right format. Please also do not drag and drop or select the whole folder, select the individual files. | 52 | - `Recipe files`: Recipe files that you created using the [Franz recipe creation guide](https://github.com/meetfranz/plugins/blob/master/docs/integration.md). Please do *not* package your files beforehand - upload the raw files (you can drag and drop multiple files). ferdi-server will automatically package and store the recipe in the right format. Please also do not drag and drop or select the whole folder, select the individual files. |
54 | 53 | ||
54 | ### Listing custom recipes | ||
55 | Inside Ferdi, searching for `ferdi:custom` will list all your custom recipes. | ||
56 | |||
55 | ## License | 57 | ## License |
56 | ferdi-server is licensed under the MIT License | 58 | ferdi-server is licensed under the MIT License |