diff --git a/README.md b/README.md index fa1c6a5..a551475 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Nexus Client +> [!WARNING] +> Nexus Client is still in development, and doesn't support everything needed for daily use. + ## Description A simple and user-friendly Matrix client made with Flutter and a Gomuks backend. @@ -10,13 +13,113 @@ A simple and user-friendly Matrix client made with Flutter and a Gomuks backend. | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------: | | ![Screenshot of Nexus Client in dark mode, showing users talking, with a sidebar showing rooms and spaces, and another sidebar showing members](./assets/screenshotDark.png) | ![The same screenshot as above, but in light mode](./assets/screenshotLight.png) | +## Progress + +- [x] Platform Support + - [x] Linux + - [x] Notifications through UnifiedPush + - [x] Windows + - [ ] Background notifications + - [x] Android + - [x] Notifications through UnifiedPush + - [x] Notifications through FCM + - [x] MacOS + - [x] Unsigned .ipa + - [ ] App Store + - [ ] Background notifications + - [x] iOS + - [x] Unsigned .ipa + - [ ] App Store + - [ ] Background notifications + - [ ] Web (may not be possible) +- [x] Login (via OAuth) +- [x] Rooms / Spaces + - [x] Displaying and choosing + - [x] Reading, showing unread + - [x] Mark as read button on rooms and spaces + - [ ] Searching + - [ ] Creating (Rooms, Spaces, and DMs) + - [x] Joining + - [x] Parse vias + - [x] Using a text/uri/link + - [x] Plain text + - [x] `matrix:` Uri + - [x] Matrix.to link + - [ ] From space + - [ ] From directory + - [x] Leaving + - [x] Subspaces +- [x] Messages + - [x] Encryption + - [x] Restoring crypto identity from a recovery passphrase/key + - [x] Sending + - [x] Plain text + - [x] HTML/Markdown + - [x] Replies + - [x] Choose ping on/off + - [x] Per message profiles + - [x] Attachments + - [ ] Commands with [MSC4391](https://github.com/matrix-org/matrix-spec-proposals/pull/4391) + - [x] Tags + - [x] Users + - [x] Rooms + - [x] Emojis + - [ ] Custom emojis/stickers + - [ ] GIFs using Gomuks' GIF proxies + - [x] Receiving + - [x] Plain text + - [x] Per message profiles + - [x] HTML + - [x] URL Previews + - [x] Replies + - [x] Viewing + - [x] Jump to original message + - [x] Edits + - [x] Attachments + - [x] Unencrypted + - [x] Encrypted + - [x] Blurhashing + - [ ] Downloading attachments + - [x] Opening attachments in their own view + - [ ] Polls + - [x] Mentions + - [x] Users + - [x] Clickable + - [x] Rooms + - [x] Clickable + - [x] Matrix URIs + - [x] Matrix.to links + - [x] Events + - [x] Custom emojis/stickers + - [x] History loading + - [x] Editing + - [x] Deleting +- [x] Reactions +- [x] Pins + - [x] Displaying + - [x] Pinning/Unpinning +- [ ] Threads +- [x] Profile popouts + - [x] Working actions +- [x] Copy link to: + - [x] Room + - [x] Space + - [x] Message +- [ ] Reporting + - [x] Events + - [ ] Rooms +- [x] Member list + - [x] Sort by power level + - [ ] Colors based off of power level +- [x] Notifications using UnifiedPush ([#35](https://git.federated.nexus/Nexus/nexus/issues/35)) +- [x] Notifications page +- [ ] Group calls using [MSC4195](https://github.com/matrix-org/matrix-spec-proposals/pull/4195) +- [x] Invites +- [x] Settings + ## Try it out -If you want to try out Nexus, download the [latest release](https://git.federated.nexus/Nexus/nexus/releases/latest). - -### Nightly Builds - -For the newest changes, grab one of the following nightly artifacts, built by CI from the latest commit on `main`. +If you want to try out Nexus, grab one of the following artifacts from CI: - [Android APK](https://nightly.link/Henry-Hiles/nexus/workflows/android/main/APK.zip) - [Unsigned iOS IPA](https://nightly.link/Henry-Hiles/nexus/workflows/ios/main/Nexus.ipa.zip) @@ -25,7 +128,7 @@ For the newest changes, grab one of the following nightly artifacts, built by CI Or, use one of the below methods: -### Nightly Flatpak Repo +### Flatpak Make sure Flatpak is set up on your system, then run: @@ -46,12 +149,6 @@ nexus = { }; ``` -This tracks the latest commit on `main`. To stay on a release instead, pin the input to its tag: - -```nix -url = "git+https://git.federated.nexus/Nexus/nexus?ref=refs/tags/v1.0.0-alpha1"; -``` - Then import the module and enable it in your NixOS configuration: ```nix @@ -159,7 +256,7 @@ Development instructions can be found in [DEVELOPMENT.md](./DEVELOPMENT.md). Join the [Nexus Client Matrix room](https://matrix.to/#/#nexus:federated.nexus) for questions or help with developing or using Nexus Client. -## Credits +# Credits Thank you Hylke Bons (https://planetpeanut.studio) for making the amazing icon for Nexus! Thank you Tulir Asokan for making [Gomuks](https://github.com/gomuks/gomuks), and helping us integrate it into Nexus! diff --git a/assets/screenshotDark.png b/assets/screenshotDark.png index 48be6e5..322a64e 100644 Binary files a/assets/screenshotDark.png and b/assets/screenshotDark.png differ diff --git a/assets/screenshotLight.png b/assets/screenshotLight.png index 5aae7a0..8772bcf 100644 Binary files a/assets/screenshotLight.png and b/assets/screenshotLight.png differ diff --git a/assets/twim/.gitkeep b/assets/twim/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/assets/twim/summary.png b/assets/twim/summary.png new file mode 100644 index 0000000..70d9a50 Binary files /dev/null and b/assets/twim/summary.png differ