aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Makazzz <makazzzpro@live.ca>2019-10-26 00:02:25 -0400
committerLibravatar Makazzz <makazzzpro@live.ca>2019-10-26 00:02:25 -0400
commitb9c85b44706c94d59893fcf2a32a2ccaf3ceb12f (patch)
treee05097bf70f882f4490a2e8034f8fc4a6cb95b6d /README.md
parentMerge pull request #157 from getferdi/l10n_develop (diff)
downloadferdium-app-b9c85b44706c94d59893fcf2a32a2ccaf3ceb12f.tar.gz
ferdium-app-b9c85b44706c94d59893fcf2a32a2ccaf3ceb12f.tar.zst
ferdium-app-b9c85b44706c94d59893fcf2a32a2ccaf3ceb12f.zip
Improved README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md60
1 files changed, 51 insertions, 9 deletions
diff --git a/README.md b/README.md
index 285c80bb0..8df081753 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,52 @@
4 4
5# Ferdi 5# Ferdi
6 6
7[![Backers on Open Collective](https://opencollective.com/getferdi/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/getferdi/sponsors/badge.svg)](#sponsors) [![Build Status Windows](https://ci.appveyor.com/api/projects/status/2ckfbmoxp36fye5b?svg=true)](https://ci.appveyor.com/project/kytwb/ferdi) 7<p align="center">
8[![Build Status Mac & Linux](https://travis-ci.org/getferdi/ferdi.svg?branch=master)](https://travis-ci.org/getferdi/ferdi) 8<a href="#backers-via-opencollective"><img alt="Open Collective backers" src="https://img.shields.io/opencollective/backers/getferdi?logo=open-collective"></a>
9<a href="#sponsors-via-opencollective"><img alt="Open Collective sponsors" src="https://img.shields.io/opencollective/sponsors/getferdi?logo=open-collective"></a>
10<a href="https://ci.appveyor.com/project/kytwb/ferdi"><img alt="Build Status Windows" src="https://img.shields.io/appveyor/ci/kytwb/ferdi/master?logo=appveyor"></a>
11<a href="https://travis-ci.org/getferdi/ferdi"><img alt="Build Status Mac & Linux" src="https://img.shields.io/travis/getferdi/ferdi/master?logo=travis"></a>
12</p>
9 13
10🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. 14🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones.
11 15
16#### Table of contents
17
18<details>
19<summary>Ferdi</summary>
20<ul>
21<li><a href="#what-is-ferdi">What is Ferdi ?</a></li>
22<li><a href="#what-ferdi-looks-like">What Ferdi looks like ?</a></li>
23<li><a href="#download-ferdi">Download Ferdi</a>
24<ul>
25<li><a href="#or-use-homebrew-macos-only">Or use homebrew</a></li>
26</ul>
27</li>
28<li><a href="#ferdi-specific-features">Ferdi-specific Features</a></li>
29<li><a href="#development">Development</a></li>
30<li><a href="#contributors">Contributors ✨</a></li>
31<li><a href="#backers-via-opencollective">Backers via OpenCollective</a></li>
32<li><a href="#sponsors-via-opencollective">Sponsors via OpenCollective</a></li>
33</ul>
34</details>
35
36### What is Ferdi ?
37
38Ferdi is based on Franz - a messaging browser already used by thousands of people. Due to this, Ferdi is compatible with all Franz recipes and your existing Franz account. Ferdi is a messaging browser that allows you to combine your favorite messaging services into one application and doesn't restrict its usage. Use every service you want, as many times as you want and how you want.
39
40### What Ferdi looks like ?
41
42<details>
43<summary>Screenshots</summary>
44<img alt="Keep all your messaging services in one place." src="./branding/screenshots/hero.png">
45<img alt="Order your services with Ferdi Workspaces." src="./branding/screenshots/workspaces.png">
46<img alt="Always keep your Todo list open with Ferdi Todos." src="./branding/screenshots/todos.png">
47<img alt="Supporting all your services." src="./branding/screenshots/service-store.png">
48</details>
49
12## Download Ferdi 50## Download Ferdi
13 51
14You can find the installers in the [latest release](https://github.com/getferdi/ferdi/releases) assets. 52You can find the installers in the [latest stable release](https://github.com/getferdi/ferdi/releases/latest) assets and the [pre-release ones here](https://github.com/getferdi/ferdi/releases).
15 53
16### Or use homebrew (macOS only) 54### Or use homebrew (macOS only)
17 55
@@ -94,7 +132,7 @@ $ git submodule update --init --recursive
94 132
95It is important you execute the last command to get the required submodules (recipes, server). 133It is important you execute the last command to get the required submodules (recipes, server).
96 134
97### Install dependencies 135#### Install dependencies
98 136
99Run the following command to install all dependencies, and link sibling modules with Ferdi. 137Run the following command to install all dependencies, and link sibling modules with Ferdi.
100 138
@@ -104,13 +142,13 @@ $ npx lerna bootstrap
104 142
105If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. 143If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`.
106 144
107### Fix native modules to match current electron node version 145#### Fix native modules to match current electron node version
108 146
109```bash 147```bash
110$ npm run rebuild 148$ npm run rebuild
111``` 149```
112 150
113### Start development app 151#### Start development app
114 152
115Run these two commands **simultaneously** in different console tabs: 153Run these two commands **simultaneously** in different console tabs:
116 154
@@ -121,7 +159,7 @@ $ npm run start
121 159
122Be aware that the development database will be reset regularly. 160Be aware that the development database will be reset regularly.
123 161
124### Packaging 162#### Packaging
125 163
126```bash 164```bash
127$ npm run build 165$ npm run build
@@ -129,7 +167,7 @@ $ npm run build
129 167
130Deliverables will be available in the `out` folder. 168Deliverables will be available in the `out` folder.
131 169
132### Release 170#### Release
133 171
134```bash 172```bash
135$ git checkout develop && git pull && git checkout master 173$ git checkout develop && git pull && git checkout master
@@ -187,4 +225,8 @@ This project follows the [all-contributors](https://github.com/all-contributors/
187 225
188## Backers via OpenCollective 226## Backers via OpenCollective
189 227
190<a href="https://opencollective.com/getferdi#backers" target="_blank"><img src="https://opencollective.com/getferdi/backers.svg?width=890"></a> 228<a href="https://opencollective.com/getferdi#section-contribute" target="_blank"><img src="https://opencollective.com/getferdi/backers.svg?width=890"></a>
229
230## Sponsors via OpenCollective
231
232<a href="https://opencollective.com/getferdi#section-contribute" target="_blank"><img src="https://opencollective.com/getferdi/sponsors.svg?width=890"></a>