From 47c6c1aaada6248a7102adc12b535c9396da6547 Mon Sep 17 00:00:00 2001 From: Mark Cooper Date: Thu, 30 Sep 2021 19:57:13 -0500 Subject: [PATCH] Readme update --- client/pages/upload/index.vue | 6 ++-- readme.md | 56 +++-------------------------------- 2 files changed, 7 insertions(+), 55 deletions(-) diff --git a/client/pages/upload/index.vue b/client/pages/upload/index.vue index 143431d0..2c01a646 100644 --- a/client/pages/upload/index.vue +++ b/client/pages/upload/index.vue @@ -31,7 +31,7 @@ Select files -

{{ inputAccept.join(', ') }}

+

{{ inputAccept }}

@@ -120,9 +120,9 @@ export default { title: null, author: null, series: null, - acceptedAudioFormats: ['.mp3', '.m4b', '.m4a'], + acceptedAudioFormats: ['.mp3', '.m4b', '.m4a', '.flac'], acceptedImageFormats: ['image/*'], - inputAccept: ['image/*, .mp3, .m4b, .m4a'], + inputAccept: 'image/*, .mp3, .m4b, .m4a, .flac', isDragOver: false, showUploader: true, validAudioFiles: [], diff --git a/readme.md b/readme.md index d63d9a6a..87bde472 100644 --- a/readme.md +++ b/readme.md @@ -11,62 +11,14 @@ Android app is in beta, try it out on the [Google Play Store](https://play.googl Screenshot1 -## Directory Structure +## Organizing your audiobooks - See [documentation](https://audiobookshelf.org/docs) for directory structure and naming. +#### Directory structure and folder names are critical to AudioBookshelf! -Author, Series, Volume Number, Title and Publish Year can all be parsed from your folder structure. - -**Note**: Files in the root directory `/audiobooks` will be ignored, all audiobooks should be in a directory - -**1 Folder:** `/Title/...`\ -**2 Folders:** `/Author/Title/...`\ -**3 Folders:** `/Author/Series/Title/...` - -### Parsing publish year - -`/1984 - Hackers/...`\ -Will save the publish year as `1984` and the title as `Hackers` - -### Parsing volume number (only for series) - -`/Book 3 - Hackers/...`\ -Will save the volume number as `3` and the title as `Hackers` - -`Book` `Volume` `Vol` `Vol.` are all supported case insensitive - -These combinations will also work:\ -`/Hackers - Vol. 3/...`\ -`/1984 - Volume 3 - Hackers/...`\ -`/1984 - Hackers Book 3/...` + See [documentation](https://audiobookshelf.org/docs) for supported directory structure, folder naming conventions, and audio file metadata usage. -### Parsing subtitles (optional in settings) -Title Folder: `/Hackers - Heroes of the Computer Revolution/...` - -Will save the title as `Hackers` and the subtitle as `Heroes of the Computer Revolution` - - -### Full example - -`/Steven Levy/The Hacker Series/1984 - Hackers - Heroes of the Computer Revolution - Vol. 1/...` - -**Becomes:** -| Key | Value | -|---------------|-----------------------------------| -| Author | Steven Levy | -| Series | The Hacker Series | -| Publish Year | 1984 | -| Title | Hackers | -| Subtitle | Heroes of the Computer Revolution | -| Volume Number | 1 | - - -## Features coming soon - -* Support different views to see more details of each audiobook -* iOS App (Android is in beta [here](https://play.google.com/store/apps/details?id=com.audiobookshelf.app)) ## Installation @@ -120,7 +72,7 @@ Get the `deb` file from the [github repo](https://github.com/advplyr/audiobooksh See [instructions](https://www.audiobookshelf.org/install#debian) -#### File locations +#### Linux file locations Project directory: `/usr/share/audiobookshelf/`