From 2fb2ab9b460442d7e7f87200e54f4d0554155138 Mon Sep 17 00:00:00 2001
From: vaxerski <vaxry@vaxry.net>
Date: Thu, 28 Dec 2023 20:50:54 +0100
Subject: [PATCH] update readme

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 67e5500..77c7c22 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
 # hyprlang
-The official implementation library for the hypr config language.
+The hypr configuration language is an extremely efficient, yet easy to work with, configuration language
+for linux applications.
+
+It's user-friendly, easy to grasp, and easy to implement.
+
+## Example config
+
+```ini
+bakery {
+    counter_color = rgba(ee22eeff)          # color by rgba()
+    door_color = rgba(122, 176, 91, 0.1)    # color by rgba()
+    dimensions = 10 20                      # vec2
+    employees = 3                           # int
+    average_time_spent = 8.13               # float
+    hackers_password = 0xDEADBEEF           # int, as hex
+
+    # nested categories
+    secrets {
+        password = hyprland                 # string
+    }
+}
+
+cakes {
+    number = 3                              # int
+    colors = red, green, blue               # string
+}
+
+# keywords, invoke your own handler with the parameters
+add_baker = Jeremy, 26, Warsaw
+add_baker = Andrew, 21, Berlin
+add_baker = Koichi, 18, Morioh
+```
+
+## Docs
+
+Soon:tm: