X-Git-Url: https://git.sommitrealweird.co.uk/bpgallery.git/blobdiff_plain/657a5a1384747ed03979162ea282e5653a790acc..a1d6b3a6cd44d43f9561e31ac0933186a5d5b71b:/README

diff --git a/README b/README
index 6af9d16..9a4aec8 100644
--- a/README
+++ b/README
@@ -10,6 +10,7 @@ The ImageMagick tools (convert and identify)
 bash
 GNU find
 GNU xargs
+sed
 
 Installation
 ------------
@@ -19,8 +20,21 @@ Usage
 -----
 bpgallery.sh /path/to/image/files
 
+Also, the following files, if placed in the images directory, will be used to
+generate part of the index page:
+        description.txt - a simple text file containing paragraphs to go at the
+                          beginnings of the index page
+        captions.txt - filename<tab>caption style file, it'll add a caption to
+                       the images on the index page.
+The following environment variables can also be used:
+        TITLE - the title of the gallery
+        WIDTH - the width to make the icons
+
+Example Usage:
+        TITLE="My Funky Gallery" bpgallery.sh /path/to/image/files
+
 Author
 ------
 Brett Parker:
-	e-mail: <iDunno@sommitrealweird.co.uk>
-	www:    http://www.sommitrealweird.co.uk/
+        e-mail: <iDunno@sommitrealweird.co.uk>
+        www:    http://www.sommitrealweird.co.uk/