From 444aed57aec7a85102c9144049229c72807f4c49 Mon Sep 17 00:00:00 2001 From: Varun Patil Date: Thu, 20 Oct 2022 14:08:46 -0700 Subject: [PATCH] Update docs --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 05f579ff..41674e89 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,10 @@ Memories is a photo management app for Nextcloud with advanced features includin 1. ☁ Clone this into your `apps` folder of your Nextcloud. 1. 👩‍💻 In a terminal, run the command `make dev-setup` to install the dependencies. -1. 🏗 Then to build the Typescript whenever you make changes, run `make build-js`. Watch changes with: `make watch-js`. +1. 🏗 To build the Typescript, run `make build-js`. Watch changes with: `make watch-js`. 1. ✅ Enable the app through the app management of your Nextcloud. 1. 🎉 Partytime! -## 🤔 Why a separate app? -The approach of this app is fundamentally different from the official Nextcloud Photos app, which is very lightweight and works entirely using webdav. This app instead maintains special metadata in a separate table on the backend, and thus can be considered to have different objectives. - ## ⚡ Performance - Once properly configured, Memories is **extremely fast**, possibly one of the fastest web photo viewers. - On a server with relatively cheap hardware (`Intel Pentium G6400 / 8GB RAM / SSD`), loading the timeline takes only `~400ms` without cache on a laptop (`Intel Core i5-1035G1 / Windows 11 / Chrome`) for a library of `~17000 photos` totaling `100GB`. The test was performed on Nextcloud 24 with `nginx`, `php-fpm` and `mariadb` running in Docker. @@ -49,8 +46,7 @@ The approach of this app is fundamentally different from the official Nextcloud - The app can work with external storage for photos. Just set the mountpoint as the timeline directory. - If you add any photos from outside Nextcloud, you must run the scan and index commands. - Indexing may be slow, since all files must be downloaded from the storage. The app currently assumes that the Exif data is present with the first 20MB of each file. - - This function is experimental and may not work as expected. Please report any issues. - The archive feature moves photos to a separate folder called `.archive` at the root of your timeline. You can use this, for example, to move these photos to a cold storage. ## Special Thanks -Nextcloud team. At least one half of the code is based on the work of the [Nextcloud Photos](https://github.com/nextcloud/photos). \ No newline at end of file +Nextcloud team. A lot of this work is based on [Photos](https://github.com/nextcloud/photos). \ No newline at end of file