diff --git a/README.md b/README.md index 9231797c..2e4db9c3 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,16 @@ [](./LICENSE.md) [](https://github.com/viktorstrate/photoview/graphs/contributors) [](https://hub.docker.com/r/viktorstrate/photoview) -[](https://hub.docker.com/r/viktorstrate/photoview/) +[](https://github.com/photoview/photoview/actions/workflows/build.yml) +[](https://codecov.io/gh/photoview/photoview)  -Photoview is a simple and user-friendly photo gallery that can easily be installed on personal servers. -It's made for photographers and aims to provide an easy and fast way to navigate directories, with thousands of high resolution photos. +Photoview is a simple and user-friendly photo gallery that's made for photographers and aims to provide an easy and fast way to navigate directories, with thousands of high-resolution photos. + +You configure Photoview to look for photos and videos within a directory on your file system. The scanner automatically picks up your media and start to generate thumbnail images to make browsing super fast. + +When your media has been scanned they show up on the website, organised in the same way as on the filesystem. > If you have questions regarding setup or development, feel free to join the Discord server https://discord.gg/jQ392948u9 @@ -115,11 +119,11 @@ They can be installed as shown below: ```sh # Ubuntu -sudo apt-get install libdlib-dev libblas-dev liblapack-dev libjpeg-turbo8-dev +sudo apt-get install libdlib-dev libblas-dev liblapack-dev libjpeg-turbo8-dev libheif-dev # Debian -sudo apt-get install libdlib-dev libblas-dev liblapack-dev libjpeg62-turbo-dev +sudo apt-get install libdlib-dev libblas-dev liblapack-dev libjpeg62-turbo-dev libheif-dev # macOS -brew install dlib +brew install dlib libheif ``` @@ -157,4 +161,10 @@ And the graphql playground at [localhost:4001](http://localhost:4001) @robin-moser +