From 48b2e4c3ab98f339f12d726596bd382cc7e94837 Mon Sep 17 00:00:00 2001
From: Zeeshan Ali Khan <zeeshan_ali.khan@mercedes-benz.com>
Date: Thu, 29 Jun 2023 19:51:11 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Populate=20&=20update=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++--
 1 file changed, 39 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9234e09..57801fa 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,44 @@
 # busd
 
-A simple D-Bus bus (broker) implementation. This is mainly intended as an easy way to setup CI for any D-Bus using project (including zbus and zbus-based code). Since it's pure Rust, it's much easier to build for Linux, Mac and Windows than other D-Bus brokers.
+A D-Bus bus (broker) implementation in Rust. Since it's pure Rust, it's much easier to build for
+multiple platforms (Linux, Mac and Windows being the primary targets) than other D-Bus brokers.
 
 ## Status
 
-Very early development. Only a few things work.
+Alpha. It's not ready for production use yet. Only the essentials are in place.
+
+## Installation & Use
+
+Currently, we can only offer installation from source:
+
+```bash
+cargo install -f busd
+```
+
+Running a session instance is super easy:
+
+```bash
+busd --print-address
+```
+
+`--print-address` will print the address of the bus to stdout. You can then use that address to
+connect to the bus:
+
+```bash
+export DBUS_SESSION_BUS_ADDRESS="unix:path=/run/user/1000/bus,guid=d0af79a44c000ce7985797ba649dbc05"
+busctl --user introspect org.freedesktop.DBus /org/freedesktop/DBus
+busctl --user list
+```
+
+Since auto-starting of services is not yet implemented, you'll have to start services manually:
+
+```bash
+# Probably not the best example since the service just exits after a call to it.
+/usr/libexec/dleyna-renderer-service &
+busctl call --user com.intel.dleyna-renderer /com/intel/dLeynaRenderer com.intel.dLeynaRenderer.Manager GetRenderers
+```
+
+## License
+
+MIT license [LICENSE-MIT](LICENSE-MIT)
+