Skip to content

Commit

Permalink
πŸ“ Populate & update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeeshan Ali Khan committed Jun 29, 2023
1 parent cc3a025 commit 48b2e4c
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 48b2e4c

Please sign in to comment.