Fix dark/light in readme

This commit is contained in:
Henry Hiles 2025-11-30 22:15:18 -05:00
commit 5cb897d89e
No known key found for this signature in database

188
README.md
View file

@ -1,6 +1,5 @@
# Nexus Client # Nexus Client
> [!WARNING] > [!WARNING]
> Nexus Client is still heavily in development, and is not ready for use! > Nexus Client is still heavily in development, and is not ready for use!
@ -10,107 +9,112 @@ A simple and user-friendly Matrix client made with Flutter and the Matrix Dart S
## Screenshots ## Screenshots
Light Mode | Dark Mode | Dark Mode | Light Mode |
:-:|:-: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------: |
![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) | ![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 ## Progress
- [ ] Platform Support
- [x] Linux - [ ] Platform Support
- [x] Windows (untested, if you are interested in helping to test, open an issue) - [x] Linux
- [ ] MacOS - [x] Windows (untested, if you are interested in helping to test, open an issue)
- [ ] Android - [ ] MacOS
- [ ] iOS - [ ] Android
- [ ] Web (may not be possible) - [ ] iOS
- [x] Login - [ ] Web (may not be possible)
- [x] Username / password auth - [x] Login
- [ ] OAuth / OIDC - [x] Username / password auth
- [x] Rooms / Spaces - [ ] OAuth / OIDC
- [x] Displaying and choosing - [x] Rooms / Spaces
- [x] Reading, showing unread - [x] Displaying and choosing
- [ ] Mark as read button on rooms and spaces - [x] Reading, showing unread
- [ ] Searching - [ ] Mark as read button on rooms and spaces
- [ ] Creating (Rooms, Spaces, and DMs) - [ ] Searching
- [ ] Joining - [ ] Creating (Rooms, Spaces, and DMs)
- [ ] Using alias - [ ] Joining
- [ ] From space - [ ] Using alias
- [ ] Exploring - [ ] From space
- [ ] Leaving - [ ] Exploring
- [ ] Subspaces - [ ] Leaving
- [x] Messages - [ ] Subspaces
- [x] Sending - [x] Messages
- [x] Plain text - [x] Sending
- [x] HTML/Markdown - [x] Plain text
- [x] Replies - [x] HTML/Markdown
- [ ] Attachments - [x] Replies
- [ ] Mentions - [ ] Attachments
- [ ] Users - [ ] Mentions
- [ ] Rooms - [ ] Users
- [ ] Custom emojis/stickers - [ ] Rooms
- [ ] GIFs, maybe through Tenor or something - [ ] Custom emojis/stickers
- [ ] Encrypted messages - [ ] GIFs, maybe through Tenor or something
- [x] Recieving - [ ] Encrypted messages
- [x] Plain text - [x] Recieving
- [x] HTML - [x] Plain text
- [x] Replies - [x] HTML
- [x] Viewing - [x] Replies
- [ ] Jump to original message - [x] Viewing
- [x] Edits - [ ] Jump to original message
- [x] Attachments - [x] Edits
- [ ] Downloading attachments - [x] Attachments
- [ ] Opening attachments in their own view - [ ] Downloading attachments
- [ ] Mentions - [ ] Opening attachments in their own view
- [ ] Users - [ ] Mentions
- [ ] Rooms - [ ] Users
- [ ] Plain text - [ ] Rooms
- [ ] Matrix URIs - [ ] Plain text
- [ ] Matrix.to links - [ ] Matrix URIs
- [ ] Custom emojis/stickers - [ ] Matrix.to links
- [ ] Encrypted messages - [ ] Custom emojis/stickers
- [x] History loading - [ ] Encrypted messages
- [x] Backwards - [x] History loading
- [ ] Forwards - [x] Backwards
- [ ] Fix bug with edits - [ ] Forwards
- [x] Editing - [ ] Fix bug with edits
- [x] Deleting - [x] Editing
- [ ] Reactions - [x] Deleting
- [ ] Pins - [ ] Reactions
- [ ] Displaying - [ ] Pins
- [ ] Creating - [ ] Displaying
- [ ] Threads - [ ] Creating
- [ ] Profile popouts - [ ] Threads
- [ ] Copy link to [message, room, space] - [ ] Profile popouts
- [ ] Reporting - [ ] Copy link to [message, room, space]
- [ ] Notifications using UnifiedPush - [ ] Reporting
- [ ] Group calls using [MSC4195](https://github.com/matrix-org/matrix-spec-proposals/pull/4195) - [ ] Notifications using UnifiedPush
- [ ] Invites - [ ] Group calls using [MSC4195](https://github.com/matrix-org/matrix-spec-proposals/pull/4195)
- [ ] Viewing / accepting - [ ] Invites
- [ ] Spam filtering - [ ] Viewing / accepting
- [ ] Devices - [ ] Spam filtering
- [ ] Viewing devices - [ ] Devices
- [ ] Verifying devices - [ ] Viewing devices
- [ ] Settings - [ ] Verifying devices
- [ ] Light/Dark mode - [ ] Settings
- [ ] Dynamic Theming - [ ] Light/Dark mode
- [ ] URL preview: Server / Client / None - [ ] Dynamic Theming
- [ ] Account changes - [ ] URL preview: Server / Client / None
- [ ] Display name - [ ] Account changes
- [ ] Profile picture - [ ] Display name
- [ ] Timezone - [ ] Profile picture
- [ ] Pronouns - [ ] Timezone
- [ ] Password - [ ] Pronouns
- [ ] About - [ ] Password
- [x] Log Out - [ ] About
- [x] Log Out
## Development ## Development
Fork and clone the project, then: Fork and clone the project, then:
- With Nix: Either use direnv, or `nix flake develop`
- Without Nix: Install Flutter, Rust, the libsecret dev package for your distro (must be in `PKG_CONFIG_PATH`), and sqlite (must be in `LD_LIBRARY_PATH`). - With Nix: Either use direnv, or `nix flake develop`
- Without Nix: Install Flutter, Rust, the libsecret dev package for your distro (must be in `PKG_CONFIG_PATH`), and sqlite (must be in `LD_LIBRARY_PATH`).
Build generated files, and watch for new changes: Build generated files, and watch for new changes:
```sh ```sh
flutter pub run build_runner watch --delete-conflicting-outputs flutter pub run build_runner watch --delete-conflicting-outputs
``` ```
Run `flutter run` to run the app. Run `flutter run` to run the app.
## Community ## Community