diff --git a/.gitignore b/.gitignore index 783a4ae..b56593e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *~ *.sw[op] +doc/screenshots/.DS_Store diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 0685205..f6bc4be 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,9 +1,10 @@ -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. +PhotoPrism® is an AI-Powered Photos App for the Decentralized Web. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud. ### 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." +- Browse all your photos and videos without worrying about RAW conversion, duplicates or video formats +- Easily find specific pictures using powerful search filters +- Includes four high-resolution world maps to bring back the memories of your favorite trips +- Play Live Photos™ by hovering over them in albums and search results +- Recognizes the faces of your family and friends +- Automatic classification of pictures based on their content and location diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index aded581..4b9dc57 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... + * Not tested yet with AMD architecture + * Photoprism currently supports only one user. OIDC should be supported within a few months + * Photoprism requires an important amount of RAM and disk to install or to work properly -* 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 ? +* At first install, you'll be prompted for credentials + * Username is "admin" + * Password is the password you have set during the installation diff --git a/doc/screenshots/example.jpg b/doc/screenshots/example.jpg deleted file mode 100644 index a1efa1a..0000000 Binary files a/doc/screenshots/example.jpg and /dev/null differ diff --git a/doc/screenshots/photoprism.jpg b/doc/screenshots/photoprism.jpg new file mode 100644 index 0000000..f8dd81d Binary files /dev/null and b/doc/screenshots/photoprism.jpg differ