diff --git a/README.md b/README.md index d4db06ae..d4c691f7 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,44 @@ [![Dependency Status](https://david-dm.org/bpatrik/PiGallery2.svg)](https://david-dm.org/bpatrik/PiGallery2) [![devDependency Status](https://david-dm.org/bpatrik/PiGallery2/dev-status.svg)](https://david-dm.org/bpatrik/PiGallery2#info=devDependencies) -This is a photo gallery optimised for running low resource servers (especially on raspberry pi) +This is a directory-first photo gallery website, optimised for running on low resource servers (especially on raspberry pi) -Work in progess.... Estimated first release 2016 summer + +Work in progess.... Estimated first beta in 2017 summer Live Demo @ heroku: https://pigallery2.herokuapp.com/ + +Feature list: + * **Rendering directories as it is** + * Listing subdirectories recursively + * Listing photos in a nice grid layout + * supporting most common image formats + * showing **tag/keywords, locations, GPS coordinates** for photos + * rendering photos on demand (on scroll) + * On the **fly thumbnail generation** in several sizes + * prioritizes thumbnail generation (generating thumbnail first for the visible photos) + * saving generated thumbnails to TEMP folder for reuse + * supporting several core CPU + * supporting hardware acceleration - `In progress` + * Custom lightbox for full screen photo viewing + * keyboard support for navigation - `In progress` + * showing low-res thumbnail while full image loads + * Information panel for showing **Exif info** - `In progress` + * Client side caching (folders and search results) + * Rendering **photos** with GPS coordinates **on google map** + * .gpx file support - `In progress` + * **Two modes: SQL database and no-database-mode** + * both modes: user management + * password protection can be disabled/enabled + * database mode supports: + * faster directory listing + * searching + * instant search, auto complete + * sharing - `In progress` + * setting link expiration time + * Nice design - `In progress` + * responsive design (phone, tablet desktop support) + * Setup page - `In progress` + * **Markdown based blogging support** - `In progress` + * you can write some note in the blog.md for every directory + * bug free :) - `In progress`