Update readme to include features to implement

This commit is contained in:
Tha_14 2024-03-09 19:26:30 +01:00
parent 63ccc1eb32
commit 2250ec645d

View File

@ -17,16 +17,13 @@
See [FAQ](FAQ/en.md). See [FAQ](FAQ/en.md).
<img src="https://raw.githubusercontent.com/Zoxcore/Antidote/develop/docs/app001.png" height="200px">&nbsp;<img src="https://raw.githubusercontent.com/Zoxcore/Antidote/develop/docs/app003.png" height="200px">&nbsp;<img src="https://raw.githubusercontent.com/Zoxcore/Antidote/develop/docs/app004.png" height="200px">&nbsp;<img src="https://raw.githubusercontent.com/Zoxcore/Antidote/develop/docs/app002.png" height="200px">&nbsp;<img src="https://raw.githubusercontent.com/Zoxcore/Antidote/develop/docs/applewatch_push.jpg" height="200px"> <img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/app001.png" height="200px">&nbsp;<img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/app003.png" height="200px">&nbsp;<img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/app004.png" height="200px">&nbsp;<img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/app002.png" height="200px">&nbsp;<img src="https://git.plastiras.org/Tha_14/Antidote/raw/branch/master/docs/applewatch_push.jpg" height="200px">
## Help Translate the App in your Language ## Help Translate the App in your Language
Use Weblate: Use Weblate:
https://hosted.weblate.org/engage/antidote/ https://hosted.weblate.org/engage/antidote/
## Get in touch
* <a href="https://matrix.to/#/#antidote:libera.chat">Join discussion on Matrix</a><br>
## Usage ## Usage
#### Install from the App Store #### Install from the App Store
@ -38,7 +35,7 @@ https://hosted.weblate.org/engage/antidote/
Clone repo, install pods and open `Antidote.xcworkspace` file with Xcode 12+. Clone repo, install pods and open `Antidote.xcworkspace` file with Xcode 12+.
``` ```
git clone https://github.com/Antidote-for-Tox/Antidote.git git clone https://git.plastiras.org/Tha_14/Antidote/.git
cd Antidote cd Antidote
pod install pod install
open Antidote.xcworkspace open Antidote.xcworkspace
@ -48,7 +45,7 @@ open Antidote.xcworkspace
Clone repo, install pods and install Xcode 12+ Clone repo, install pods and install Xcode 12+
``` ```
git clone https://github.com/Antidote-for-Tox/Antidote.git git clone https://git.plastiras.org/Tha_14/Antidote/.git
cd Antidote cd Antidote
pod install pod install
env NSUnbufferedIO=YES xcodebuild -workspace ./Antidote.xcworkspace -scheme Antidote -destination 'platform=iOS Simulator,id=EAB9614F-3485-4A6D-8EFB-FC2B5EFB0243' env NSUnbufferedIO=YES xcodebuild -workspace ./Antidote.xcworkspace -scheme Antidote -destination 'platform=iOS Simulator,id=EAB9614F-3485-4A6D-8EFB-FC2B5EFB0243'
@ -59,24 +56,23 @@ env NSUnbufferedIO=YES xcodebuild -workspace ./Antidote.xcworkspace -scheme Anti
See [CHANGELOG](CHANGELOG.md) for list of notable changes (unreleased, current and previous versions). See [CHANGELOG](CHANGELOG.md) for list of notable changes (unreleased, current and previous versions).
- one to one conversations - one to one conversations
- typing notification - typing notifications
- emoticons - emoticons
- spell check - spell checking
- reading/scanning Tox ID via QR code - reading/scanning Tox ID via QR code
- file transfer - file transfers
- read receipts - read receipts
- push message support (via Apple Push Notification) / Push in <a href="https://github.com/Zoxcore/qTox_enhanced/releases">qTox</a>.
- multiple profiles - multiple profiles
- tox_save import/export - tox_save import/export
- avatars - avatars
- audio calls - audio calls
- video calls - video calls
Not implemented yet features:
## Send Crashreports - Service to wake up antidote through push notifications every x minutes
- Add confirmation dialogue before sending files
https://developer.apple.com/documentation/xcode/acquiring-crash-reports-and-diagnostic-logs<br><b>please first check that the crashreport does NOT contain any private data!</b><br>send to zoff@zoxcore.org - Options in settings under advanced to set a socks5 proxy
- Option under advanced to change the NoSpam(manual and a randomize button options)
<img src="https://raw.githubusercontent.com/Zoxcore/Antidote/develop/docs/iphone_send_crashreports.png" height="350px"> - Introduction modal when creating and signing in with a new profiles
## License ## License