From 18e7f6f709bca854061937512de1104ed5ab8b0c Mon Sep 17 00:00:00 2001
From: moonstar-x <christian.lopez99@outlook.com>
Date: Tue, 30 May 2023 01:26:46 -0500
Subject: [PATCH] Updated README.

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 83393c9..37ea9c0 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,35 @@
 # kavita-books-organizer
 
-A simple script that moves single files to a folder with their name so Kavita will work when scanning the library.
\ No newline at end of file
+A simple script that moves single files to a folder with their name so Kavita will work when scanning the library.
+
+## Installation
+
+Clone this repository, then install dependencies:
+
+```text
+npm install
+```
+
+## Usage
+
+Set the `FILES_DIR` environment variable to the parent directory for all the files that need to be organized.
+
+Then simply use:
+
+```text
+npm start
+```
+
+## With Docker
+
+You may use the docker image as such:
+
+```bash
+docker run \
+  -it \
+  --rm \
+  --name=kavita-books-organizer \
+  -e FILES_DIR=/data \
+  -v $PWD/books:/data \
+  code.moonstar-x.dev/public/kavita-books-organizer:latest
+```