Update README.md

README.md

@@ -1,35 +1,69 @@
 # SteamOS Manager
 
-SteamOS Manager is a small daemon whose primary purpose is to give Steam
+SteamOS Manager is a system daemon that aims to abstract steam's
-something with a DBus API that runs as root and can do things to the system
+interactions with the operating system. The goal is to have a standardized
-without having to have hard coded paths and DBus API in the Steam client
+interface so that SteamOS specific features in the Steam client, e.g. TDP
-itself. It also runs some background tasks, as well as giving a centralized
+management, can be exposed in any linux distro that provides an implementation
-daemon for managing some user-context tasks that aren't particularly related to
+of this DBus API.
-Steam itself.
 
-Many of these root tasks are implemented as athin wrapper around other scripts.
+The interface may be fully or partially implemented. The Steam client will
-This lets the DBus APIs invoke the scripts as a privileged but non-root user
+check which which features are available at startup and restrict the settings
-and provides feedback for each DBus method it implements.
+it presents to the user based on feature availability.
 
-## How it works
+Some of the features that SteamOS Manager enables include:
+- GPU clock management
+- TDP management
+- BIOS/Dock updates
+- Storage device maintenance tasks
+- External storage device formatting
+  * Steam geneally performs device enumeration via UDisks2, but formatting happens via SteamOSManager
 
-The SteamOS Manager runs as `root` and exposes a DBus API on the system bus.
+For a full list of features please refer to the [interface specification](https://gitlab.steamos.cloud/holo/steamos-manager/-/blob/master/com.steampowered.SteamOSManager1.xml).
-Another instance runs as `deck` and exposes a DBus API on the session bus with
-a few extra methods that handle tasks that are user-specific. These methods run
-directly in the user daemon as that user. All other APIs are relayed to the
-root daemon via its DBus API.
 
-## To add a new method
+Other notable dbus interfaces used by the Steam Client include:
+  * org.freedesktop.UDisks2
+  * org.freedesktop.portal.desktop
+  * org.freedesktop.login1
+  * org.bluez
 
-To add a new method that doesn't require root privileges, add it to the user
-daemon's DBus API directly. This is implemented in `src/manager/usr.rs`
 
-To add a new method that does require root privileges, add it to the root
+## Interface compatibility notes
-daemon's DBus API in `src/manager/root.rs`, update the proxy implementation in
-`src/proxy.rs`, and add a relay method in `src/manager/user.rs`.
 
-In both cases, make sure to add the new API to the XML schema. The methods are
+SteamOS Manager and the Steam client are normally updated independently of
-test automatically to match the schema, so these tests will fail if they don't.
+each other. So the interface must remain binary compatible across releases.
+
+In general, when making changes to the interface please consider the following:
+- Method signatures must not be altered
+  * Instead, prefer exposing a new symbol and add a compatibility adapter to the previous interface
+- Changes in behaviour should be avoided
+  * Consider how a change would affect the beta and stable release of the Steam client
+- Features must have a mechanism to discover if they are available or not
+  * E.g. for a feature exposed as a property if the property is not present on the bus it means the feature is unsupported.
+
+Note that while SteamOS Manager must never break binary compatibility of
+the interface, the Steam client makes no guarantees that older versions of
+an interface will be used if available. As a rule of thumb, the client will
+always provide full support for the SteamOS Manager interface version available
+in the Stable release of SteamOS.
+
+
+## Implementation details
+
+SteamOS Manager is compromised of two daemons, one runs as the logged in user
+and exposes a public DBus API on the session bus. And the second daemon runs as
+the `root` user and exposes a limited DBus API on the system bus for tasks
+that require elevated permissions to execute.
+
+The DBus API exposed on the system bus is considered a private implementation
+detail of SteamOS Manager and it may be changed at any moment and without warning.
+For this reason, we don't provide an XML schema for the system daemon's interface.
+
+## Extending the API
+
+To extend the API with a new method or property first update the XML schema.
+Then extend the user daemon's DBus API which is implemented in `src/manager/usr.rs`.
+
+If the new functionality requires elevated privileges, then extend the system
+daemon's DBus API in `src/manager/root.rs` with the necessary helpers to complete
+the task. Please consider keeping as much logic as possible in the user context.
 
-Further, if this is the first change made to the schema since the last tag,
-increment the API version number in `src/lib.rs`.