From 957a53fd8cdda205c5a3a8372fac2bbb3d677b54 Mon Sep 17 00:00:00 2001
From: jmb05 <jmb05@web.de>
Date: Sun, 1 Nov 2026 16:50:18 +0100
Subject: [PATCH] Add README.md

---
 Cargo.toml  |  4 ++--
 README.md   | 44 ++++++++++++++++++++++++++++++++++++++++++++
 src/main.rs |  1 -
 3 files changed, 46 insertions(+), 3 deletions(-)
 create mode 100644 README.md

diff --git a/Cargo.toml b/Cargo.toml
index ef0e956..130145a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -4,11 +4,11 @@ version = "0.1.0"
 edition = "2024"
 
 [[bin]]
-name = "jmb-bar"
+name = "jmbbar"
 path = "src/main.rs"
 
 [[bin]]
-name = "ctl"
+name = "jmbctl"
 path = "src/ctl.rs"
 
 [dependencies]
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..40884ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# jmb-bar
+... is a status bar, action center and app launcher. It is built for wayland and hyprland.
+Additionally, it acts as an idle daemon. It is written in rust and uses Gtk 4 and 
+gtk-layer-shell. 
+**This is a hobby project and for my own personal use. It might be unoptimized in 
+some places and naively implemented. It is also most definitely not very customizable 
+and highly opinionated. Use at your own risk.**
+
+### Building and Running
+To build the project you need the rust compiler and cargo installed.
+See here: [https://rust-lang.org/tools/install/](https://rust-lang.org/tools/install/).
+
+First clone the project:
+```bash
+git clone https://git.jmb19905.net/jmb05/jmb-bar
+```
+
+switch to the project directory:
+```bash
+cd jmb-bar
+```
+
+To build run:
+```bash
+cargo build --bins --release
+```
+
+this build two executables in the `target/release/` the `jmbbar` executable launches
+the bar and `jmbctl` can be used to query state and send commands.
+
+Using:
+```bash
+cargo install --bins
+```
+installs the binaries to `~/.cargo/bin`. If you have that path in you `PATH` variable
+you can run the executables from anywhere.
+
+### Usage
+
+#### Starting the bar
+`jmbbar` or `./jmbbar` (depending on your installation location)
+
+#### Controlling
+- `jmbctl menu` opens the app launcher
diff --git a/src/main.rs b/src/main.rs
index cf9ec24..53ce003 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -5,7 +5,6 @@ mod css;
 mod ctl;
 mod ui;
 
-use crate::config::Config;
 use glib::clone;
 use gtk::prelude::*;
 use gtk::{Application, CssProvider, gdk, gio};