From b9c85b44706c94d59893fcf2a32a2ccaf3ceb12f Mon Sep 17 00:00:00 2001 From: Makazzz Date: Sat, 26 Oct 2019 00:02:25 -0400 Subject: Improved README.md --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 51 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 285c80bb0..8df081753 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,52 @@ # Ferdi -[![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) -[![Build Status Mac & Linux](https://travis-ci.org/getferdi/ferdi.svg?branch=master)](https://travis-ci.org/getferdi/ferdi) +

+Open Collective backers +Open Collective sponsors +Build Status Windows +Build Status Mac & Linux +

🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. +#### Table of contents + +
+Ferdi + +
+ +### What is Ferdi ? + +Ferdi 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. + +### What Ferdi looks like ? + +
+Screenshots +Keep all your messaging services in one place. +Order your services with Ferdi Workspaces. +Always keep your Todo list open with Ferdi Todos. +Supporting all your services. +
+ ## Download Ferdi -You can find the installers in the [latest release](https://github.com/getferdi/ferdi/releases) assets. +You 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). ### Or use homebrew (macOS only) @@ -94,7 +132,7 @@ $ git submodule update --init --recursive It is important you execute the last command to get the required submodules (recipes, server). -### Install dependencies +#### Install dependencies Run the following command to install all dependencies, and link sibling modules with Ferdi. @@ -104,13 +142,13 @@ $ npx lerna bootstrap If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. -### Fix native modules to match current electron node version +#### Fix native modules to match current electron node version ```bash $ npm run rebuild ``` -### Start development app +#### Start development app Run these two commands **simultaneously** in different console tabs: @@ -121,7 +159,7 @@ $ npm run start Be aware that the development database will be reset regularly. -### Packaging +#### Packaging ```bash $ npm run build @@ -129,7 +167,7 @@ $ npm run build Deliverables will be available in the `out` folder. -### Release +#### Release ```bash $ git checkout develop && git pull && git checkout master @@ -187,4 +225,8 @@ This project follows the [all-contributors](https://github.com/all-contributors/ ## Backers via OpenCollective - + + +## Sponsors via OpenCollective + + -- cgit v1.2.3-54-g00ecf