Skip to content

Commit 419d6f4

Browse files
committed
Update README
1 parent d29d41b commit 419d6f4

File tree

1 file changed

+35
-47
lines changed

1 file changed

+35
-47
lines changed

README.md

+35-47
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Molly
22

33
[![Test](https://github.com/mollyim/mollyim-android/workflows/Test/badge.svg)](https://github.com/mollyim/mollyim-android/actions)
4+
[![Reproducible build](https://github.com/mollyim/mollyim-android/actions/workflows/reprocheck.yml/badge.svg)](https://github.com/mollyim/mollyim-android/actions/workflows/reprocheck.yml)
45
[![Translation status](https://hosted.weblate.org/widgets/molly-instant-messenger/-/svg-badge.svg)](https://hosted.weblate.org/engage/molly-instant-messenger/?utm_source=widget)
56
[![Financial contributors](https://opencollective.com/mollyim/tiers/badge.svg)](https://opencollective.com/mollyim#category-CONTRIBUTE)
67

@@ -10,9 +11,9 @@ Molly is a hardened version of [Signal](https://github.com/signalapp/Signal-Andr
1011

1112
Back in 2018, Signal allowed the user to set a passphrase to secure the local message database. But this option was removed with the introduction of file-based encryption on Android. Molly brings it back again with additional security features.
1213

13-
Molly connects to the Signal server, so you can chat with your Signal contacts seamlessly. Please remember to review the [Signal Terms & Privacy Policy](https://signal.org/legal/) before signing up.
14+
Molly connects to Signal's servers, so you can chat with your Signal contacts seamlessly. Before signing up, please remember to review the [Signal Terms & Privacy Policy](https://signal.org/legal/).
1415

15-
We update Molly every two weeks to include the latest features and bug fixes from Signal. The exceptions are security issues, which are patched as soon as fixes become available.
16+
We update Molly every two weeks to include the latest Signal features and fixes. The exceptions are security patches, which are applied as soon as they are available.
1617

1718
## Download
1819

@@ -22,95 +23,82 @@ You can download the app from GitHub's [Releases](https://github.com/mollyim/mol
2223
alt="Get it on F-Droid"
2324
height="80">](https://molly.im/fdroid/)
2425

25-
There are two flavors to choose from download: **Molly** or **Molly-FOSS**. Learn the differences [below](#free-and-open-source) and download the right one for you.
26+
There are two versions available: **Molly** or **Molly-FOSS**. Learn the differences [below](#free-and-open-source) and download the right one for you.
2627

27-
You can also download **Molly-FOSS** from [Accrescent](https://accrescent.app/):
28+
You can also get **Molly-FOSS** from [Accrescent](https://accrescent.app/):
2829

2930
<a href="https://accrescent.app/app/im.molly.app">
3031
<img alt="Get it on Accrescent"
3132
src="https://accrescent.app/badges/get-it-on.png"
3233
height="80">
3334
</a>
3435

35-
Signing certificate fingerprints to [verify](https://developer.android.com/studio/command-line/apksigner#usage-verify) the APK:
36+
To [verify](https://developer.android.com/studio/command-line/apksigner#usage-verify) the APK, use the following signing certificate fingerprints:
3637
```
3738
SHA-256: 6aa80fdf4a8cc13737cfb434fc0cde486f09cf8fcda21a67bea5ee1ca2700886
3839
SHA-1: 49ce310cdd0c09c8c34eb31a8005c6bf13f5a4f1
3940
```
4041

41-
To explore latest experimental features, consider **Molly Insider**, our dedicated app for beta testing. Find out more here: [Molly Insider on GitHub](https://github.com/mollyim/mollyim-insider-android).
42-
4342
## Features
4443

4544
Molly has unique features compared to Signal:
4645

47-
- **Data encryption at rest** - Protect the database with [passphrase encryption](https://github.com/mollyim/mollyim-android/wiki/Data-Encryption-At-Rest)
46+
- **Data encryption at rest** - Protect your app database with [passphrase encryption](https://github.com/mollyim/mollyim-android/wiki/Data-Encryption-At-Rest)
4847
- **Secure RAM wiper** - Securely shred sensitive data from device memory
49-
- **Automatic lock** - Lock the app automatically under certain conditions
50-
- **Multi-device support** -- Link multiple devices, including Android tablets, to a single account
48+
- **Automatic lock** - Lock the app automatically under user-defined conditions
49+
- **Multi-device support** - Link multiple devices to a single Signal account, including Android tablets
50+
- **UnifiedPush** - Receive push notifications without Google through the UnifiedPush protocol
5151
- **Block unknown contacts** - Block messages and calls from unknown senders for security and anti-spam
52-
- **Disappearing call history** - Clear call notifications together with expiring messages
53-
- **Debug logs are optional** - Android logging can be disabled
54-
- **Custom backup scheduling** - Choose between a daily or weekly interval and the number of backups to retain
52+
- **Disappearing call history** - Clear call logs together with expiring messages
53+
- **Custom backup scheduling** - Set daily or weekly interval and the number of backups to retain
5554
- **SOCKS proxy and Tor support** - Tunnel app network traffic via proxy and Orbot
55+
- **Debug logs are optional** - Android logging can be disabled
5656

57-
For the [UnifiedPush](#unifiedpush) version of Molly, the following features are additionally available:
58-
59-
- **UnifiedPush support**: Receive push notifications through the UnifiedPush protocol
60-
61-
Besides that, you will find all the features of Signal plus some minor tweaks and improvements. As with Signal, SMS is not supported.
57+
Additionally, you will find all the features of Signal, along with some minor tweaks and improvements.
6258

6359
## Free and Open-Source
6460

65-
Molly is open-source just like Signal. But Signal uses Google's proprietary software to provide some key features.
61+
Molly is open-source just like Signal. But Signal depends on proprietary Google software for some features.
6662

67-
To support a 100% free and auditable app, Molly comes in two flavors: one with proprietary blobs like Signal and one without. They are called Molly and Molly-FOSS, respectively. You can install the flavor of your choice at any time, and it will replace any previously installed version. The data and settings will be preserved so that you do not have to re-register.
63+
To support a 100% free and auditable app, Molly comes in two versions: one with proprietary blobs like Signal, and one without. They are called Molly and Molly-FOSS, respectively. You can install the flavor of your choice at any time, and it will replace any previously installed version. The data and settings will be preserved so that you do not have to re-register.
6864

69-
### UnifiedPush
65+
### Feature Comparison
7066

71-
[Molly-UP](https://github.com/mollyim/mollyim-android-unifiedpush) is a separate app based on Molly-FOSS. It incorporates the ability to receive notifications through a UnifiedPush provider.
67+
Here's how some key features work in different versions of the app:
7268

73-
> [!IMPORTANT]
74-
> Molly-UP **requires** an instance of [mollysocket](https://github.com/mollyim/mollysocket) to work with a UnifiedPush provider. This can be done on a machine you control.
69+
| Feature | Molly-FOSS | Molly | Signal |
70+
| --------------------------------- | ---------------- | -------------------- | -------------------- |
71+
| Push notifications <sup>(1)</sup> | ✔ WebSocket<br>✔ UnifiedPush | ⚠ FCM<br>✔ WebSocket<br>✔ UnifiedPush | ⚠ FCM<br>✔ WebSocket |
72+
| Location sharing | ✔ OpenStreetMap | ⚠ Google Maps | ⚠ Google Maps |
7573

76-
If Molly-UP is set up as a secondary linked device, UnifiedPush notifications will not be available.
74+
<sup>(1)</sup> You might need to turn off system-level battery restrictions for the app to receive messages when the app isn't open.
7775

78-
### Dependency Comparison
76+
### UnifiedPush
7977

80-
This table lists the current status of the dependencies:
78+
[UnifiedPush](https://unifiedpush.org/) is an open standard for delivering push notifications, offering a privacy-friendly alternative to Google's proprietary FCM service. It allows users to choose their own notification distributor.
8179

82-
| Feature | Molly-FOSS | Molly-UP | Molly | Signal |
83-
| ------------------------------------- | ---------------- | --------------- | -------------------- | -------------------- |
84-
| Push notifications <sup>(1) (2)</sup> | ✔ Websocket | ✔ UnifiedPush<br>✔ Websocket | ⚠ FCM<br>✔ Websocket | ⚠ FCM<br>✔ Websocket |
85-
| Location provider | ✔ OpenStreetMap | ✔ OpenStreetMap | ⚠ Google Maps | ⚠ Google Maps |
80+
> [!IMPORTANT]
81+
> To use UnifiedPush notifications, you need access to a [MollySocket](https://github.com/mollyim/mollysocket) server to link your Signal account to UnifiedPush. You can either run MollySocket on a server you control (strongly advised) or use a public instance.
8682
87-
<sup>(1)</sup> You may need to disable the system battery optimizations to receive Websocket-based push notifications in background.<br>
88-
<sup>(2)</sup> If you are running a custom operating system and the app fails to register with Play Services (FCM) try the FOSS flavor.
83+
Currently, UnifiedPush is unavailable for linked devices.
8984

9085
## Compatibility with Signal
9186

92-
Molly and Signal apps can be installed on the same device. If you need a 2nd number to chat, you can use Molly along with Signal.
87+
Molly and Signal apps can be installed on the same device. If you need a second number for messaging, you can register Molly with a different number while keeping Signal active. Any phone number capable of receiving SMS or calls can be used during registration.
9388

94-
However, you cannot use the same phone number on both apps at the same time. Only the last app registered will remain active, and the other will go offline. Remember that you are not limited to use only your main phone number - you can use any number on which you can receive SMS or phone calls at registration.
89+
If you wish to use the same phone number for both Molly and Signal, you must register Molly as a linked device. Registering the same number independently on both apps will result in only the most recently registered app staying active, while the other will go offline.
9590

96-
If you are currently a Signal user and want to use Molly instead of Signal
97-
(with the same phone number), see [Migrating From
98-
Signal](https://github.com/mollyim/mollyim-android/wiki/Migrating-From-Signal)
99-
on the wiki.
91+
For Signal users looking to switch to Molly without changing the phone number, please refer to the [Migrating From Signal](https://github.com/mollyim/mollyim-android/wiki/Migrating-From-Signal) guide on the wiki.
10092

10193
## Backups
10294

103-
Backups are fully compatible. Signal [backups](https://support.signal.org/hc/en-us/articles/360007059752-Backup-and-Restore-Messages) can be restored in Molly, and the other way around, simply by choosing the backup folder and file. However, to import a backup from Signal you must use a matching or newer version of Molly.
104-
105-
For older releases of Android, you might need to rename the backup file and copy it into the expected path, so the app can find the backup to restore during installation. These are the locations within internal storage where backups are written by default:
106-
- `Signal/Backups/Signal-year-month-date-time.backup`
107-
- `Molly/Backups/Molly-year-month-date-time.backup`
95+
Backups are fully compatible. Signal [backups](https://support.signal.org/hc/en-us/articles/360007059752-Backup-and-Restore-Messages) can be restored in Molly, and the other way around, simply by choosing the backup folder and file. However, to import a backup from Signal, you must use a matching or newer version of Molly.
10896

10997
## Feedback
11098

111-
- [Submit bugs and feature requests](https://github.com/mollyim/mollyim-android/issues)
99+
- [Submit bugs and feature requests](https://github.com/mollyim/mollyim-android/issues) on GitHub
112100
- Join us at [#mollyim:matrix.org](https://matrix.to/#/#mollyim:matrix.org) on Matrix
113-
- For news, tips and tricks follow [@mollyim](https://fosstodon.org/@mollyim) on Mastodon
101+
- For news, tips, and tricks, follow [@mollyim](https://fosstodon.org/@mollyim) on Mastodon
114102

115103
## Reproducible Builds
116104

@@ -128,6 +116,6 @@ License and legal notices in the original [README](README-ORIG.md).
128116

129117
## Disclaimer
130118

131-
This project is *NOT* sponsored by Signal Messenger or Signal Foundation.
119+
This project is *NOT* sponsored by Signal Messenger or the Signal Foundation.
132120

133121
The software is produced independently of Signal and carries no guarantee about quality, security or anything else. Use at your own risk.

0 commit comments

Comments
 (0)