Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs #18

Merged
merged 1 commit into from
Jun 20, 2023
Merged

docs #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@ This package was built for [`bookshelves-project/bookshelves`](https://github.co
- [`intl`](https://www.php.net/manual/en/book.intl.php) (native, optional) for `Transliterator`
- [`fileinfo`](https://www.php.net/manual/en/book.fileinfo.php) (native, optional) for better detection of file type

| Type | Supported | Requirement | Uses |
| :--------------------------------: | :-------: | :------------------------------------------------------------------------------------------------------: | :------------------: |
| `.epub`, `.cbz` | ✅ | N/A | N/A |
| `.cbt` | ✅ | N/A | N/A |
| `.cbr` | ✅ | [`rar` PHP extension](https://github.com/cataphract/php-rar) or [`p7zip`](https://www.7-zip.org/) binary | PHP `rar` or `p7zip` |
| `.cb7` | ✅ | [`p7zip`](https://www.7-zip.org/) binary | `p7zip` binary |
| `.pdf` | ✅ | Optional (for extraction) [`imagick` PHP extension](https://github.com/Imagick/imagick) | `smalot/pdfparser` |
| `mp3`, `m4a`, `m4b`, `flac`, `ogg` | ✅ | N/A | `kiwilan/php-audio` |
| Type | Supported | Requirement | Uses |
| :-------------------------------------: | :-------: | :------------------------------------------------------------------------------------------------------: | :------------------: |
| `.epub`, `.cbz` | ✅ | N/A | N/A |
| `.cbt` | ✅ | N/A | N/A |
| `.cbr` | ✅ | [`rar` PHP extension](https://github.com/cataphract/php-rar) or [`p7zip`](https://www.7-zip.org/) binary | PHP `rar` or `p7zip` |
| `.cb7` | ✅ | [`p7zip`](https://www.7-zip.org/) binary | `p7zip` binary |
| `.pdf` | ✅ | Optional (for extraction) [`imagick` PHP extension](https://github.com/Imagick/imagick) | `smalot/pdfparser` |
| `.mp3`, `.m4a`, `.m4b`, `.flac`, `.ogg` | ✅ | N/A | `kiwilan/php-audio` |

> **Warning**
>
Expand All @@ -73,7 +73,7 @@ This package was built for [`bookshelves-project/bookshelves`](https://github.co
- `CBAM` (Comic Book Archive Metadata) : `ComicInfo.xml` format from _ComicRack_ and maintained by [`anansi-project`](https://github.com/anansi-project/comicinfo)
- `PDF` with [`smalot/pdfparser`](https://github.com/smalot/pdfparser)
- Audiobooks: `ID3`, `vorbis` and `flac` tags with [`kiwilan/php-audio`](https://github.com/kiwilan/php-audio)
- 🔖 `EPUB` only support chapters extraction
- 🔖 Chapters extraction (`EPUB` only)

<!-- - 📦 `EPUB` and `CBZ` creation supported -->
<!-- - 📝 `EPUB` and `CBZ` metadata update supported -->
Expand All @@ -87,7 +87,6 @@ This package was built for [`bookshelves-project/bookshelves`](https://github.co
- [ ] Add `.fb2`, `.lrf`, `.pdb`, `.snb` support
- [ ] Add `.epub` creation support
- [ ] Add `.epub` metadata update support
- [ ] Add `.epub` chapters extraction support

## Installation

Expand Down