diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 0685205..4c0073f 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,9 +1,14 @@ -Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. +Audiobookshelf is a self-hosted audiobook server for managing and playing your audiobooks. ### Features -- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; -- Laboris nisi ut aliquip ex ea commodo consequat ; -- Duis aute irure dolor in reprehenderit in voluptate ; -- Velit esse cillum dolore eu fugiat nulla pariatur ; -- Excepteur sint occaecat cupidatat non proident, sunt in culpa." +* Fully **open-source**, including the [android & iOS app](https://github.com/advplyr/audiobookshelf-app) *(in beta)* +* Stream all audiobook formats on the fly +* Multi-user support w/ custom permissions +* Keeps progress per user and syncs across devices +* Auto-detects library updates, no need to re-scan +* Upload audiobooks w/ bulk upload drag and drop folders +* Backup your metadata + automated daily backups +* Progressive Web App (PWA) +* Chromecast support on the web app +* Fetch metadata and cover art from several sources \ No newline at end of file diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index aded581..4a08255 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,12 +1,8 @@ -* Any known limitations, constrains or stuff not working, such as (but not limited to): - * requiring a full dedicated domain ? - * architectures not supported ? - * not-working single-sign on or LDAP integration ? - * the app requires an important amount of RAM / disk / .. to install or to work properly - * etc... +## Limitations -* Other infos that people should be aware of, such as: - * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) - * how to configure / administrate the application if it ain't obvious - * upgrade process / specificities / things to be aware of ? - * security considerations ? +* Audiobookshelf can only be installed on a dedicated domain +* No LDAP support + +## Administration + +* Default user is "root" with no password diff --git a/doc/screenshots/example.jpg b/doc/screenshots/example.jpg index a1efa1a..3de8a64 100644 Binary files a/doc/screenshots/example.jpg and b/doc/screenshots/example.jpg differ