initial commit

1 files changed, 54 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..fbb8b8760
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+**This repository is only for Franz 5 and later, previous versions are no longer maintained.**
+---
+
+<img src="./build-helpers/images/icon.png" alt="" width="150"/>
+
+# Franz 5 (beta) [![Build status Windows](https://ci.appveyor.com/api/projects/status/22e01sssgdt90d34/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master) [![Build Status Mac](https://travis-ci.com/meetfranz/franz.svg?token=9zxYPVb6RdKVnmTFMJLX&branch=master)](https://travis-ci.com/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](http://meetfranz.com/payment.html)
+
+Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more.
+
+
+## Development
+
+### Preparations
+#### Install yarn
+##### MacOS
+```bash
+$ brew install yarn
+```
+##### Windows
+[Download installer](https://yarnpkg.com/latest.msi)
+
+#### Install Gulp 4
+```bash
+$ yarn add global gulp-cli@1.2.2
+$ yarn add global gulpjs/gulp#4.0
+```
+
+
+### Run Franz Development App
+Run these two commands __simultaneously__ in different console tabs.
+
+```bash
+$ yarn run dev
+$ yarn start
+```
+
+## Packaging
+```bash
+$ yarn build
+```
+
+## How can I support the project?
+If you have found a bug that hasn't been reported yet, please open a new issue.
+
+## I need help?
+Join the Franz community on [Slack](https://slack.franz.im) and get in touch with us.
+
+## Next steps
+- [ ] Create acceptance tests
+- [ ] 5.0 stable release
+- [ ] Developer Documentation
+
+## License
+Franz 5 is open-source licensed under the GPLv2 License.