From 260305295af45858f3479d92b80d08c16241c6dd Mon Sep 17 00:00:00 2001
From: Quentin Roussel <contact@quentinrsl.com>
Date: Sat, 20 Sep 2025 01:33:15 +0800
Subject: [PATCH] added README

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a7d6685
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Singapore Rain Radar
+This project automatically fetches and processes rain radar images from the [Meteorological Service Singapore (MSS)](https://www.weather.gov.sg/) website. It downloads the latest radar images, and generates an animated GIF to visualize the rain patterns over Singapore. This is helpful to integrate into home automation systems or weather monitoring applications.
+![Singapore Rain Radar](https://quentinrsl.com/other/sg_rain_radar/output.gif)
+## How to use
+1. Clone the repository:
+   ```bash
+   git clone https://git.roussel.pro/public/singapore_rain_radar
+   ```
+3. Run the docker container :
+    ```bash
+    make run
+    ```
+4. The animated GIF will be saved as `output.gif` in the OUTPUT_DIR directory set in the Makefile.