From 05dd597a1dd17bc533ce2da33f15fea802eb4565 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=81d=C3=A1m=20Kov=C3=A1cs?= <kovacsadam07@outlook.hu>
Date: Tue, 15 Apr 2025 15:21:58 +0200
Subject: [PATCH] docs: readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index e69de29..90f42ed 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+# Raspberry PI Pico W Doorbell
+
+This is a simple doorbell built on the Raspberry Pi Pico W with Zig and the Pico C SDK.
+
+# Usage
+
+Create a setting.json in the src folder similar to this one:
+```json
+{
+    "ssid": "YOUR_WIFI_NAME",
+    "password": "WIFI_PASSWORD",
+    "ntfy_url":"http://ntfy.sh/YOUR_CHANNEL_NAME"
+}
+```
+
+***Note: Without this file, the project will not compile!***
+
+The content of the settings.json is processed comptime so the file will not be placed on the pico.