From 45c1b43e7d5b2016103b11f3fa45221fb553583e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nicol=C3=A1s=20Ortega=20Froysa?= <nicolas@ortegas.org>
Date: Sat, 25 Jan 2025 10:52:43 +0100
Subject: [PATCH] Add info to README.md

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

diff --git a/README.md b/README.md
index 63eb935..2d736a2 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,39 @@
 # DBus Prettifier
 
+I noticed that when working with `qdbus` that I would get long and unformatted
+outputs that are extremely difficult to read. This small program will prettify a
+file with the output so that it is much  more readable.
+
 ## Usage
 
+To run the program, simply run it as follows:
+
+```console
+$ qdbus-prettifier <in-file> <out-file>
+```
+
 ## Building
 
+Requirements:
+
+- C compiler that supports GNU99 (GCC recommended).
+- (GNU) Make
+
+Build with `make`:
+
+```console
+$ make
+cc  -std=gnu99 -Wall -Wextra -Wfatal-errors -Werror -O2 -DNDEBUG   -c -o src/main.o src/main.c
+cc -o dbus-prettifier src/main.o
+```
+
+Install with `make install`:
+
+```console
+$ sudo make install
+install -Dm755 dbus-prettifier /usr/local/bin/
+```
+
 ## License
 
 This program is licensed under the terms & conditions of the [Zlib