Added README.md

This commit is contained in:
sNice/Python
2026-03-22 17:29:08 -05:00
parent 8a59fe6455
commit ec386660f7
+63
View File
@@ -0,0 +1,63 @@
# AO3 Client
A feature-rich Android client for Archive of Our Own (AO3), designed for a seamless browsing, downloading, and reading experience.
## Features
- **Integrated AO3 Browser**: Browse the Archive with a built-in WebView that supports navigation, cookie management, and session persistence.
- **Direct Downloads**: Intercepts EPUB downloads from AO3 and saves them directly to your local library.
- **Smart Library Organization**:
- Automatically organizes your downloaded works into folders by Author.
- Recognizes Series information from EPUB metadata and organizes works into subfolders for each series.
- Cleans and formats file/folder names for better compatibility.
- **Built-in EPUB Reader**:
- Custom reader optimized for fanfiction.
- Dark mode by default for comfortable reading.
- Remembers your scroll position for every work.
- **Offline Mode**: A dedicated toggle to browse your downloaded library without an internet connection.
- **Library Management**:
- Search through your downloaded works.
- Sort by Name, Date, or File Size.
- Move, delete, and manually manage your files.
- **State Persistence**: The app remembers where you left off, including your last visited URL and the last book you were reading.
## Tech Stack
- **Language**: [Kotlin](https://kotlinlang.org/)
- **UI Framework**: [Jetpack Compose](https://developer.android.com/jetpack/compose)
- **Navigation**: [Compose Navigation](https://developer.android.com/jetpack/compose/navigation)
- **EPUB Engine**: [epublib](https://github.com/psiegman/epublib)
- **Design System**: Material 3
## Getting Started
### Prerequisites
- Android 7.0 (API level 24) or higher.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/AO3client.git
```
2. Open the project in Android Studio.
3. Build and run the app on your device or emulator.
## Usage
1. **Browsing**: Use the 'Browse' tab to find your favorite fics on AO3.
2. **Downloading**: Tap the 'Download' button on any AO3 work page and select 'EPUB'. The app will handle the rest.
3. **Organizing**: Go to the 'Downloads' tab and tap the 'Magic Wand' (Organize) icon to automatically sort your files by author and series.
4. **Reading**: Simply tap on any downloaded work in your library to open the internal reader.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
---
*Disclaimer: This is an unofficial client and is not affiliated with or endorsed by the Organization for Transformative Works (OTW) or Archive of Our Own.*