Readme update

This commit is contained in:
advplyr 2021-09-18 12:49:21 -05:00
parent c884fd6880
commit 737f8342f4

View File

@ -9,7 +9,7 @@ Android app is in beta, try it out on the [Google Play Store](https://play.googl
<img alt="Screenshot1" src="https://github.com/advplyr/audiobookshelf/raw/master/images/ss_streaming.png" /> <img alt="Screenshot1" src="https://github.com/advplyr/audiobookshelf/raw/master/images/ss_streaming.png" />
### Directory Structure ## Directory Structure
Author, Series, Volume Number, Title and Publish Year can all be parsed from your folder structure. Author, Series, Volume Number, Title and Publish Year can all be parsed from your folder structure.
@ -19,14 +19,12 @@ Author, Series, Volume Number, Title and Publish Year can all be parsed from you
**2 Folders:** `/Author/Title/...`\ **2 Folders:** `/Author/Title/...`\
**3 Folders:** `/Author/Series/Title/...` **3 Folders:** `/Author/Series/Title/...`
\ ### Parsing publish year
**Parsing publish year**
`/1984 - Hackers/...`\ `/1984 - Hackers/...`\
Will save the publish year as `1984` and the title as `Hackers` Will save the publish year as `1984` and the title as `Hackers`
\ ### Parsing volume number (only for series)
**Parsing volume number** (only if there is a series folder)
`/Book 3 - Hackers/...`\ `/Book 3 - Hackers/...`\
Will save the volume number as `3` and the title as `Hackers` Will save the volume number as `3` and the title as `Hackers`
@ -38,20 +36,19 @@ These combinations will also work:\
`/1984 - Volume 3 - Hackers/...`\ `/1984 - Volume 3 - Hackers/...`\
`/1984 - Hackers Book 3/...` `/1984 - Hackers Book 3/...`
\
**Parsing book subtitles** (optional in settings) ### Parsing subtitles (optional in settings)
Title Folder: `/Hackers - Heroes of the Computer Revolution/...` Title Folder: `/Hackers - Heroes of the Computer Revolution/...`
Will save the title as `Hackers` and the subtitle as `Heroes of the Computer Revolution` Will save the title as `Hackers` and the subtitle as `Heroes of the Computer Revolution`
\
**Full example** ### Full example
`/Steven Levy/The Hacker Series/1984 - Hackers - Heroes of the Computer Revolution - Vol. 1/...` `/Steven Levy/The Hacker Series/1984 - Hackers - Heroes of the Computer Revolution - Vol. 1/...`
Becomes:\ Becomes:\
| Author | Steven Levy | | Author | Steven Levy |
|---------------|-----------------------------------| |---------------|-----------------------------------|
| Series | The Hacker Series | | Series | The Hacker Series |