Skip to content

Commit 646c322

Browse files
authored
Update README.md
1 parent f5d862e commit 646c322

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

+20-11
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,42 @@
33
Latest release APK can be downloaded [here](https://github.com/communistWatermelon/mangadexdroid/releases).
44
New commits on `main` are built using Github Actions.
55

6+
67
## Preview
78

89
Main Screen | Notification
910
:-------------------------:|:-------------------------:
10-
<img src="https://user-images.githubusercontent.com/3271813/198726818-79539afe-564a-4d87-8ecd-116853d9481a.png" width="200"> | <img src="https://user-images.githubusercontent.com/3271813/198822770-9a124ecb-5215-4dc2-9029-50a5909eb014.png" width="200">
11+
<img src="https://github.com/user-attachments/assets/e34f6a18-bb55-4326-b2c4-6e948f751ce2" width="300"> | <img src="https://user-images.githubusercontent.com/3271813/198822770-9a124ecb-5215-4dc2-9029-50a5909eb014.png" width="200">
12+
13+
1114

1215
## Summary
13-
Simple Android project that notifies you of new chapters to manga series followed on mangadex.org. Mostly created so I could avoid using third-party RSS feeds, but also as a quick review of Android.
14-
Mostly only maintained for my own use, feel free to fork the project and build on it if necessary. I will likely not be adding any more features, and will not build an iOS version.
16+
An Android project that notifies you of new chapters to manga series followed on mangadex.org. Mostly created so I could avoid using third-party RSS feeds, but also as a testing ground for new architecture patterns.
17+
Mostly only maintained for my own use, feel free to fork the project and build on it if necessary. I'll be adding features at my own leisure, and will not build an iOS version.
1518

1619
The app will only notify you of chapters that have been released *after* you've installed the app. This is to prevent notification spam on first run.
1720

21+
1822
### Working Functionality
1923
- Logging in
2024
- Tracking/Displaying followed Manga updates from MangaDex
21-
- Notifying of chapters released after install date
25+
- Notifying of chapters released after app install date
2226
- Opening a new manga chapter from the Android notification or from the home screen
2327
- Light and Dark theme (following Android's system setting)
2428
- Material You theming (on supported devices)
29+
- Automatically caching new chapters, to improve performance at read-time
30+
- Ability to read manga chapters using a native image renderer or the system webview
31+
2532

2633
### Missing Functionality
2734
- Log out (clear app data if you want to log out)
28-
- Everything else related to MangaDex's site functionality.
35+
- Various settings that you might expect with a full consumer app
36+
- Everything else related to MangaDex's site functionality
2937

3038

3139
## General Architecture
3240
Developed using Jetpack Compose for the UI
33-
Ktor for HTTP requests
41+
Ktor for HTTP requests and file downloads
3442
Koin for Dependency Injection
3543

3644
App architecture is modelled after Google's recommended approach: Model-View-ViewModel (MVVM) with Repositories.
@@ -40,26 +48,27 @@ App architecture is modelled after Google's recommended approach: Model-View-Vie
4048
Working directly with the MangaDex API.
4149
Using global rate-limiting in Ktor, matching MangaDex's 5 per second limit.
4250

51+
4352
## Analytics/Logging
4453

45-
All logs + analytics are logged to my personal Firebase Crashlytics project, so I have information to go on in the event of a crash.
54+
All logs + analytics are logged to my personal Firebase Crashlytics project, so I have information to debug crashes or non-fatal events in the app.
4655

4756

4857
## Sync Process
4958

50-
Every ~15 minutes (while the app is foregrounded OR background), the app will go through a sync process:
59+
Every ~30 minutes (while the app is foregrounded OR background), the app will go through a sync process:
5160
1. Refresh Auth Token
5261
2. Fetch Followed Chapters
5362
3. Fetch new Manga info for unknown manga series
5463
4. Fetch covers for new manga found in step 3
55-
5. Fetch chapter read status markers for all users known manga
64+
5. Fetch chapter read status markers for the authenticated user
5665

57-
Backgronud refreshes are using WorkManager, which means the update timing is more up to Android than me.
66+
Background refreshes are using WorkManager, which means there may be some delay in the refresh.
5867

5968

6069
## Storage
6170

62-
Manga series and chapter information is stored on a local DB to avoid loading on app start, and because I hadn't done a lot of DB work previously.
71+
Manga series infor, chapter info, and read status is all stored in a local DB, powered by Room
6372
Cover images are cached and stored on device.
6473

6574

0 commit comments

Comments
 (0)