Skip to content

Commit

Permalink
TW-619: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Julian KOUNE committed Oct 23, 2023
1 parent 332a090 commit 8abd49e
Showing 1 changed file with 32 additions and 15 deletions.
47 changes: 32 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
# Twake ![Docker Pulls](https://img.shields.io/docker/pulls/linagora/twake-web)

![](https://github.com/linagora/twake-on-matrix/assets/6462404/76e7795e-39b6-4667-a313-4068afadb1ed)

<p>
<a href="https://hosted.weblate.org/projects/linagora/twake-matrix/#repository" target="new">Translate Twake</a>
</p>


FluffyChat is an open source, nonprofit and cute matrix messenger app. The app is easy to use but secure and decentralized.
# Twake
[![Contributors](https://img.shields.io/github/contributors/linagora/twake-on-matrix?label=Contributors
)](
https://github.com/linagora/twake-on-matrix/graphs/contributors
)
[![Issues](https://img.shields.io/github/issues/linagora/twake-on-matrix?label=Issues
)](https://github.com/linagora/twake-on-matrix/issues)
[![Documentation](https://img.shields.io/badge/Documentation-green.svg)](docs)
[![Android application](https://img.shields.io/badge/App-Android-blue.svg)](https://play.google.com/store/apps/dev?id=8845244706987756601)
[![Ios application](https://img.shields.io/badge/App-iOS-red.svg)](https://apps.apple.com/gr/developer/linagora/id1110867042)

<br />
<div align="center">
<a href="https://github.com/linagora/twake-on-matrix">
<img src="https://github.com/linagora/twake-on-matrix/assets/48354990/cda56167-f070-4064-90fb-81be7d20ab27">
</a>

<p align="center">
<a href="https://beta.twake.app/web/#/rooms">View Demo</a>
<a href="https://github.com/linagora/twake-on-matrix/issues">Report Bug</a>
<a href="https://hosted.weblate.org/projects/linagora/twake-matrix/#repository">Translate Twake</a>
</p>
</div>

Twake is an open source, nonprofit and cute matrix messenger app developed by [Linagora](https://linagora.com). The app is easy to use but secure and decentralized.

## Features

Expand All @@ -32,17 +49,17 @@ FluffyChat is an open source, nonprofit and cute matrix messenger app. The app i
## Setup

### Flutter
```
flutter pub get && flutter pub run build_runner build --delete-conflicting-outputs
```bash
flutter pub get && flutter pub run build_runner build --delete-conflicting-outputs
```

### Add commit hook to format and code analyze
```
bash scripts/config-pre-commit.sh
```bash
bash scripts/config-pre-commit.sh
```

# Special thanks
* <a href="https://github.com/krille-chan/fluffychat">FluffyChat</a> is the original reposotory of this project. A huge thanks to the upstream repository for their vital contributions, not only for this project but also for [Matrix SDK in Dart](https://github.com/famedly/matrix-dart-sdk)
* <a href="https://github.com/krille-chan/fluffychat">FluffyChat</a> is the original repository of this project. A huge thanks to the upstream repository for their vital contributions, not only for this project but also for [Matrix SDK in Dart](https://github.com/famedly/matrix-dart-sdk)

* <a href="https://github.com/fabiyamada">Fabiyamada</a> is a graphics designer from Brasil and has made the fluffychat logo and the banner. Big thanks for her great designs.

Expand Down

0 comments on commit 8abd49e

Please sign in to comment.