Update README.md

2025-11-30 22:00:33 -05:00 · 2025-11-30 22:00:33 -05:00 · 8c38095290
commit 8c38095290
parent 2ee02934cc
1 changed files with 101 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,103 @@
 # Nexus Client

-A simple and user-friendly Matrix client made with Flutter and the Matrix Dart SDK. 
+
+> [!WARNING]
+> Nexus Client is still heavily in development, and is not ready for use!
+
+## Description
+
+A simple and user-friendly Matrix client made with Flutter and the Matrix Dart SDK.
+
+## Screenshots
+
+Light Mode | Dark 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)
+
+## Progress
+- [ ] Platform Support
+    - [x] Linux
+    - [x] Windows (untested, if you are interested in helping to test, open an issue)
+    - [ ] MacOS
+    - [ ] Android
+    - [ ] iOS
+    - [ ] Web (may not be possible)
+- [x] Login
+    - [x] Username / password auth
+    - [ ] OAuth / OIDC
+- [x] Rooms / Spaces
+    - [x] Displaying and choosing
+    - [x] Reading, showing unread
+        - [ ] Mark as read button on rooms and spaces
+    - [ ] Searching
+    - [ ] Creating (Rooms, Spaces, and DMs)
+    - [ ] Joining
+        - [ ] Using alias
+        - [ ] From space
+        - [ ] Exploring
+    - [ ] Leaving
+    - [ ] Subspaces
+- [x] Messages
+    - [x] Sending
+        - [x] Plain text
+        - [x] HTML/Markdown
+        - [x] Replies
+        - [ ] Attachments
+        - [ ] Mentions
+            - [ ] Users
+            - [ ] Rooms
+        - [ ] Custom emojis/stickers
+        - [ ] GIFs, maybe through Tenor or something
+        - [ ] Encrypted messages
+    - [x] Recieving
+        - [x] Plain text
+        - [x] HTML
+        - [x] Replies
+            - [x] Viewing
+            - [ ] Jump to original message
+        - [x] Edits
+        - [x] Attachments
+            - [ ] Downloading attachments
+            - [ ] Opening attachments in their own view
+        - [ ] Mentions
+            - [ ] Users
+            - [ ] Rooms
+                - [ ] Plain text
+                - [ ] Matrix URIs
+                - [ ] Matrix.to links
+        - [ ] Custom emojis/stickers
+        - [ ] Encrypted messages
+        - [x] History loading
+            - [x] Backwards
+            - [ ] Forwards
+            - [ ] Fix bug with edits
+    - [x] Editing
+    - [x] Deleting
+- [ ] Reactions
+- [ ] Pins
+    - [ ] Displaying
+    - [ ] Creating
+- [ ] Threads
+- [ ] Profile popouts
+- [ ] Copy link to [message, room, space]
+- [ ] Reporting
+- [ ] Notifications using UnifiedPush
+- [ ] Group calls using [MSC4195](https://github.com/matrix-org/matrix-spec-proposals/pull/4195)
+- [ ] Invites
+    - [ ] Viewing / accepting
+    - [ ] Spam filtering
+- [ ] Devices
+    - [ ] Viewing devices
+    - [ ] Verifying devices
+- [ ] Settings
+    - [ ] Light/Dark mode
+    - [ ] Dynamic Theming
+    - [ ] URL preview: Server / Client / None
+    - [ ] Account changes
+        - [ ] Display name
+        - [ ] Profile picture
+        - [ ] Timezone
+        - [ ] Pronouns
+        - [ ] Password
+    - [ ] About
+    - [x] Log Out