From 531e0baeaaba8f63ba855d72e9020be877127dc8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ewilan=20Rivi=C3=A8re?= Date: Tue, 20 Jun 2023 14:50:55 +0200 Subject: [PATCH] docs --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3198319..1c54519 100644 --- a/README.md +++ b/README.md @@ -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** > @@ -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) @@ -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