1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..081b926
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# gal
+
+Yet another photo gallery generator.
+
+## Why?
+
+I could not find any other working solution that would be simple. This script just resizes all images and generates grid menu for them. That is all.
+
+## Usage
+
+```
+nix shell github:19pdh/gal
+
+gal [PHOTOS DIR] [OUTPUT DIR]
+```