gen-thumbs: generate video thumbnails

[dirlistozxa.git] / README.md

diff --git a/README.md b/README.md
index ffe94a36ff098e3d585c18828603c3bc4782b2ad..8dbd557a7afd244146d7dfe409d4351f6d61327f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,19 @@
-# `dirlistozxa`\r
-A simple directory lister script in PHP that will show the files and directories in a directory, along with their modification date and size.\r
+<h1 align="center"><code>dirlistozxa</code></h1>\r
 \r
+<p align="center"><img src="https://user-images.githubusercontent.com/60856959/235306666-4c66584a-f4c0-413e-bc58-09a724b02158.png"></p>\r
+\r
+A simple directory lister script in PHP that will show the files and directories in a directory, along with their modification date and size. Image thumbnail previews are also supported.\r
+\r
+## Setting up\r
 To set up, set the PHP file to be the index file, if no `index.html` or `index.php` exists in the directory. An example for nginx would be:\r
 \r
 ```nginx\r
 index index.html index.php /dirlistozxa.php;\r
 ```\r
+\r
+You need to also move the `.dirlistozxa/` folder into the root of the site, such that it is accessible at `/.dirlistozxa/`.\r
+\r
+To optionally generate image thumbnails, use the `gen-thumbs` script. Requires Imagemagick to be installed, it will generate thumbnail files into `/.thumbs/`. If the script can't find any thumbnail for an image in `/.thumbs/`, it will just fall back to the generic file image.\r
+\r
+## License\r
+`dirlistozxa` is licensed under the AGPLv3 license.\r