aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 17 insertions, 10 deletions
diff --git a/README.md b/README.md
index 67bac2277..6a3a8ff54 100644
--- a/README.md
+++ b/README.md
@@ -57,8 +57,8 @@ Ferdi is a messaging browser that allows you to combine your favorite messaging
57<em>"Keep all your messaging services in one place."</em> 57<em>"Keep all your messaging services in one place."</em>
58<img alt="Order your services with Ferdi Workspaces." src="./branding/screenshots/workspaces.png"> 58<img alt="Order your services with Ferdi Workspaces." src="./branding/screenshots/workspaces.png">
59<em>"Order your services with Ferdi Workspaces."</em> 59<em>"Order your services with Ferdi Workspaces."</em>
60<img alt="Always keep your Todo list open with Ferdi Todos." src="./branding/screenshots/todos.png"> 60<img alt="Always keep your Todos list open with Ferdi Todos." src="./branding/screenshots/todos.png">
61<em>"Always keep your Todo list open with Ferdi Todos."</em> 61<em>"Always keep your Todos list open with Ferdi Todos."</em>
62<img alt="Supporting all your services." src="./branding/screenshots/service-store.png"> 62<img alt="Supporting all your services." src="./branding/screenshots/service-store.png">
63<em>"Supporting all your services."</em> 63<em>"Supporting all your services."</em>
64</p> 64</p>
@@ -76,13 +76,12 @@ You can find the installers in the [latest stable release](https://github.com/ge
76 76
77### Or use AUR (Arch Linux) 77### Or use AUR (Arch Linux)
78 78
79Ferdi has two seperate AUR packages you can use: 79Ferdi has three seperate AUR packages you can use:
80- **ferdi-bin**: Uses your debian build and extracts it to Arch 80- **[ferdi](https://aur.archlinux.org/packages/ferdi/)**: Uses your system electron version to run the latest release
81- **ferdi-git**: Uses system electron version 81- **[ferdi-bin](https://aur.archlinux.org/packages/ferdi-bin/)**: Uses the latest Fedora release and extracts it to Arch
82- **[ferdi-git](https://aur.archlinux.org/packages/ferdi-git/)**: Uses your system electron version to run the latest commit from the develop branch
82 83
83If you use an AUR Helper e.g. yay, simply install it via `yay -S ferdi-bin`. 84If you use an AUR Helper e.g. yay, simply install it via `yay -S ferdi`.
84
85`ferdi-git` may not work on all systems so we advice you to use `ferdi-bin` instead.
86 85
87## Ferdi-specific Features 86## Ferdi-specific Features
88 87
@@ -113,11 +112,12 @@ If you use an AUR Helper e.g. yay, simply install it via `yay -S ferdi-bin`.
113- [x] Add Process Manager to find services using a lot of resources 112- [x] Add Process Manager to find services using a lot of resources
114- [x] Add "npm run prepare-code" command for development to lint and beautify code 113- [x] Add "npm run prepare-code" command for development to lint and beautify code
115- [x] Add button to open darkmode.css for a service 114- [x] Add button to open darkmode.css for a service
115- [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))
116- [x] Allow SVGs for service custom icon 116- [x] Allow SVGs for service custom icon
117- [x] Switch to [`electron-spellchecker`](https://github.com/electron-userland/electron-spellchecker) to improve application size 117- [x] Switch to [`electron-spellchecker`](https://github.com/electron-userland/electron-spellchecker) to improve application size
118- [x] Improve "About Ferdi" screen to better display versions 118- [x] Improve "About Ferdi" screen to better display versions
119- [x] Minifying build files to improve app size 119- [x] Minifying build files to improve app size
120- [x] [Makes it possible to edit the "Franz Todo" server](https://github.com/getferdi/ferdi/wiki/Custom-Todo) 120- [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)
121- [x] Makes RocketChat self-hosted generally available ([#6](https://github.com/getferdi/ferdi/issues/6)) 121- [x] Makes RocketChat self-hosted generally available ([#6](https://github.com/getferdi/ferdi/issues/6))
122- [x] Comes with a custom branding proper to Ferdi 122- [x] Comes with a custom branding proper to Ferdi
123- [x] UI improvements 123- [x] UI improvements
@@ -180,13 +180,19 @@ $ npm run rebuild
180 180
181### Start development app 181### Start development app
182 182
183Run these two commands **simultaneously** in different console tabs: 183Run these two commands **simultaneously** in different terminals:
184 184
185```bash 185```bash
186$ npm run dev 186$ npm run dev
187$ npm run start 187$ npm run start
188``` 188```
189 189
190Optionally, you can run both commands in one terminal with [misty](https://github.com/adlk/misty) (see [misty.yml](https://github.com/getferdi/ferdi/blob/develop/misty.yml)):
191
192```bash
193$ npx misty
194```
195
190Be aware that the development database will be reset regularly. 196Be aware that the development database will be reset regularly.
191 197
192### Packaging 198### Packaging
@@ -255,6 +261,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
255 <tr> 261 <tr>
256 <td align="center"><a href="http://lhw.ring0.de"><img src="https://avatars2.githubusercontent.com/u/351875?v=4" width="40px;" alt=""/><br /><sub><b>Lennart Weller</b></sub></a><br /><a href="#platform-lhw" title="Packaging/porting to new platform">📦</a></td> 262 <td align="center"><a href="http://lhw.ring0.de"><img src="https://avatars2.githubusercontent.com/u/351875?v=4" width="40px;" alt=""/><br /><sub><b>Lennart Weller</b></sub></a><br /><a href="#platform-lhw" title="Packaging/porting to new platform">📦</a></td>
257 <td align="center"><a href="https://github.com/jereksel"><img src="https://avatars0.githubusercontent.com/u/1307829?v=4" width="40px;" alt=""/><br /><sub><b>Andrzej Ressel</b></sub></a><br /><a href="https://github.com/getferdi/ferdi/commits?author=jereksel" title="Code">💻</a></td> 263 <td align="center"><a href="https://github.com/jereksel"><img src="https://avatars0.githubusercontent.com/u/1307829?v=4" width="40px;" alt=""/><br /><sub><b>Andrzej Ressel</b></sub></a><br /><a href="https://github.com/getferdi/ferdi/commits?author=jereksel" title="Code">💻</a></td>
264 <td align="center"><a href="https://gitlab.com/dpeukert"><img src="https://avatars2.githubusercontent.com/u/3451904?v=4" width="40px;" alt=""/><br /><sub><b>Daniel Peukert</b></sub></a><br /><a href="https://github.com/getferdi/ferdi/commits?author=dpeukert" title="Code">💻</a></td>
258 </tr> 265 </tr>
259</table> 266</table>
260 267