mirror of
				https://github.com/advplyr/audiobookshelf.git
				synced 2025-10-27 11:18:14 +01:00 
			
		
		
		
	Readme update
This commit is contained in:
		
							parent
							
								
									de5baba930
								
							
						
					
					
						commit
						d753683090
					
				| @ -31,7 +31,7 @@ | ||||
| 
 | ||||
|             <input ref="fileInput" id="hidden-input" type="file" multiple :accept="inputAccept" class="hidden" @change="inputChanged" /> | ||||
|             <ui-btn @click="clickSelectAudioFiles">Select files</ui-btn> | ||||
|             <p class="text-xs text-gray-300 absolute bottom-3 right-3">{{ inputAccept.join(', ') }}</p> | ||||
|             <p class="text-xs text-gray-300 absolute bottom-3 right-3">{{ inputAccept }}</p> | ||||
|           </header> | ||||
|         </section> | ||||
|         <section v-else class="h-full overflow-auto px-8 pb-8 w-full flex flex-col"> | ||||
| @ -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: [], | ||||
|  | ||||
							
								
								
									
										56
									
								
								readme.md
									
									
									
									
									
								
							
							
						
						
									
										56
									
								
								readme.md
									
									
									
									
									
								
							| @ -11,62 +11,14 @@ 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" /> | ||||
| 
 | ||||
| 
 | ||||
| ## 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/` | ||||
| 
 | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user