aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Amine Mouafik <amine@mouafik.fr>2019-04-01 07:39:30 +0700
committerLibravatar GitHub <noreply@github.com>2019-04-01 07:39:30 +0700
commitb7e579889f97f9ab17a96967fbfa707add39e632 (patch)
treeffbcff9e281c3312a0560ead9c24bdf2628c1285 /README.md
parent#1 Remove delayApp call (diff)
downloadferdium-app-b7e579889f97f9ab17a96967fbfa707add39e632.tar.gz
ferdium-app-b7e579889f97f9ab17a96967fbfa707add39e632.tar.zst
ferdium-app-b7e579889f97f9ab17a96967fbfa707add39e632.zip
Rename and add instructions for distributables
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 5 insertions, 47 deletions
diff --git a/README.md b/README.md
index f7ad7d179..db8b798d4 100644
--- a/README.md
+++ b/README.md
@@ -1,58 +1,16 @@
1**This repository is only for Franz 5 and later, previous versions are no longer maintained.**
2---
3
4<img src="./build-helpers/images/icon.png" alt="" width="150"/> 1<img src="./build-helpers/images/icon.png" alt="" width="150"/>
5 2
6# Franz 5 (beta) 3# Ferdi
7[![Build status Windows](https://ci.appveyor.com/api/projects/status/9yman4ye19x4274o/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master) 4[![Build status Windows](https://ci.appveyor.com/api/projects/status/9yman4ye19x4274o/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master)
8 [![Build Status Mac & Linux](https://travis-ci.com/meetfranz/franz.svg?branch=master)](https://travis-ci.com/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://meetfranz.com/payment.html) 5 [![Build Status Mac & Linux](https://travis-ci.com/meetfranz/franz.svg?branch=master)](https://travis-ci.com/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://meetfranz.com/payment.html)
9 6
10Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more. 7👛 Hard-fork of [Franz](https://github.com/meetfranz/franz) removing the non-skippable app delay frequently inviting you to buy a licence
11
12## [Download Franz](https://www.meetfranz.com)
13👉 www.meetfranz.com
14
15### Or use homebrew (macOS only)
16
17`$ brew cask install franz`
18
19(Don't know homebrew? [brew.sh](https://brew.sh/)
20
21## Development
22
23### Preparations
24
25#### Install Linux OS dependencies
26[Guide: Linux distribution specific dependencies](docs/linux.md)
27
28#### Fix native modules to match current electron node version
29```bash
30$ npm run rebuild
31```
32
33### Run Franz Development App
34Run these two commands __simultaneously__ in different console tabs.
35
36```bash
37$ npm run dev
38$ npm run start
39```
40Be aware that the development database will be reset regularly.
41 8
42## Packaging 9## Packaging
10
43```bash 11```bash
12$ npm install
44$ npm run build 13$ npm run build
45``` 14```
46 15
47## How can I support the project? 16Distributables will be available in the `./out` folder.
48If you have found a bug that hasn't been reported yet or want to request a new feature, please open a new issue.
49
50## I need help?
51Join the Franz community on [Slack](http://slack.franz.im) and get in touch with us.
52
53## Create your own plugins/recipes
54You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins).
55For questions feel free to ask in the [community Slack](http://slack.franz.im)
56
57## License
58Franz 5 is open-source licensed under the Apache-2.0 License.