From 5e6f63032ae8fbf1fdb23cef61c5c1ccda7917f9 Mon Sep 17 00:00:00 2001
From: Vaxry <43317083+vaxerski@users.noreply.github.com>
Date: Sat, 8 Jun 2024 19:39:18 +0200
Subject: [PATCH] README: add basic info

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 160fe9b..54e62a7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
 # hyprutils
-Hyprland utilities library used across the ecosystem
+
+Hyprutils is a small C++ library for utilities used across the Hypr* ecosystem.
+
+## Stability
+
+Hyprutils depends on the ABI stability of the stdlib implementation of your compiler. Sover bumps will be done only for hyprutils ABI breaks, not stdlib.
+
+## Building
+
+```sh
+cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -DCMAKE_INSTALL_PREFIX:PATH=/usr -S . -B ./build
+cmake --build ./build --config Release --target all -j`nproc 2>/dev/null || getconf _NPROCESSORS_CONF`
+```