forked from FrederikBaerentsen/ComicOPDS
Updated docs
This commit is contained in:
41
README.md
41
README.md
@@ -26,6 +26,20 @@ Works great with [Panels for iOS](https://panels.app) and other OPDS readers.
|
||||
|
||||
---
|
||||
|
||||
## 📱 Clients
|
||||
|
||||
**Supported Clients**
|
||||
|
||||
| App | Downloads | Search | Streaming |
|
||||
| --------------------------- | -- | -- | -- |
|
||||
| Panels (iOS) | ✔️ |✔️ |✔️ |
|
||||
| KyBook 3 (iOS) | ✔️ | ✔️ | ❌ |
|
||||
| Cantook (iOS) | ✔️ | ❌ | ❌ |
|
||||
| Marvin 3 (iOS) | ✔️ | ❌ | ❌ |
|
||||
| Chunky (iOS) | ✔️ | ❌ | ❌ |
|
||||
|
||||
---
|
||||
|
||||
## 📋 Documentation
|
||||
|
||||
- [Quick Start](docs/quickstart.md)
|
||||
@@ -34,32 +48,9 @@ Works great with [Panels for iOS](https://panels.app) and other OPDS readers.
|
||||
- [Dashboard](docs/dashboard.md)
|
||||
- [Smart Lists](docs/smartlists.md)
|
||||
- [Search](docs/search.md)
|
||||
- [Client Setup](#-client-setup)
|
||||
- [Client Setup](docs/clients.md)
|
||||
- [Troubleshooting](docs/troubleshooting.md)
|
||||
- [License](license)
|
||||
|
||||
## 📱 Clients
|
||||
|
||||
**Supported Clients**
|
||||
|
||||
| App | Downloads | Search | Streaming |
|
||||
| --------------------------- | -- | -- | -- |
|
||||
| KyBook 3 (iOS) | ✔️ | ✔️ | ❌ |
|
||||
| Cantook (iOS) | ✔️ | ❌ | ❌ |
|
||||
| Panels (iOS) | ✔️ |✔️ |✔️ |
|
||||
| Marvin 3 (iOS) | ✔️ | ❌ | ❌ |
|
||||
| Chunky (iOS) | ✔️ | ❌ | ❌ |
|
||||
|
||||
### Panels for iOS
|
||||
1. Open Panels → Library → Connect Service → OPDS
|
||||
2. **URL**: Your OPDS root (e.g., `https://comics.example.com/`)
|
||||
3. **Username/Password**: If you enabled Basic Auth
|
||||
4. Panels will display covers and use your folder structure for browsing
|
||||
|
||||
### Client-Specific Notes
|
||||
- Some clients work better with smaller `PAGE_SIZE` (e.g., 25 instead of 50)
|
||||
- Page streaming (PSE 1.1) requires client support
|
||||
- Thumbnail quality may vary between clients
|
||||
- [License](license.md)
|
||||
|
||||
---
|
||||
|
||||
|
||||
22
docs/clients.md
Normal file
22
docs/clients.md
Normal file
@@ -0,0 +1,22 @@
|
||||
## 📱 Clients
|
||||
|
||||
**Supported Clients**
|
||||
|
||||
| App | Downloads | Search | Streaming |
|
||||
| --------------------------- | -- | -- | -- |
|
||||
| Panels (iOS) | ✔️ |✔️ |✔️ |
|
||||
| KyBook 3 (iOS) | ✔️ | ✔️ | ❌ |
|
||||
| Cantook (iOS) | ✔️ | ❌ | ❌ |
|
||||
| Marvin 3 (iOS) | ✔️ | ❌ | ❌ |
|
||||
| Chunky (iOS) | ✔️ | ❌ | ❌ |
|
||||
|
||||
### Panels for iOS
|
||||
1. Open Panels → Library → Connect Service → OPDS
|
||||
2. **URL**: Your OPDS root (e.g., `https://comics.example.com/`)
|
||||
3. **Username/Password**: If you enabled Basic Auth
|
||||
4. Panels will display covers and use your folder structure for browsing
|
||||
|
||||
### Client-Specific Notes
|
||||
- Some clients work better with smaller `PAGE_SIZE` (e.g., 25 instead of 50)
|
||||
- Page streaming (PSE 1.1) requires client support
|
||||
- Thumbnail quality may vary between clients
|
||||
Reference in New Issue
Block a user