update readme

TheMoonThatRises · Aug 20, 2024 · 2e6beb5 · 2e6beb5
1 parent d3da0ea
commit 2e6beb5
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,16 @@
+<!-- markdownlint-disable-file MD033 -->
+
 # PortalBook
 
 A faster, and more efficient version of the official StudentVue app.
 
+<img alt="Home screen" src="./assets/homescreen.png" width="250">
+<img alt="Class view" src="./assets/classview.png" width="250">
+<img alt="Assignment view" src="./assets/assignmentview.png" width="250">
+
 ## Features
 
-- Cleaner, faster, more intuitive UI
+- Cleaner, faster, minimalist, more intuitive UI
 - Cached data: gradebook, student qr code load instantly
 - Faster login: <0.7s login time
 - Lightweight and written completely in SwiftUI
@@ -16,4 +22,4 @@ A faster, and more efficient version of the official StudentVue app.
 - [MijickCalendarView](https://github.com/Mijick/CalendarView)
 - [StudentVue](https://github.com/TheMoonThatRises/StudentVue.swift)
 - [SwiftSoup](https://github.com/scinfu/SwiftSoup)
-- (SWXMLHash)[https://github.com/drmohundro/SWXMLHash]
+- [SWXMLHash](https://github.com/drmohundro/SWXMLHash)
diff --git a/assets/assignmentview.png b/assets/assignmentview.png
diff --git a/assets/classview.png b/assets/classview.png
diff --git a/assets/homescreen.png b/assets/homescreen.png