From 1ad4faefea45f1d3bfe4475dbcf1497a507c99bc Mon Sep 17 00:00:00 2001
From: unitexe <unitexe70@gmail.com>
Date: Sat, 7 Jun 2025 21:56:56 -0500
Subject: Add usage documentation to README

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 32ebf55..6247e70 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
 # skopos
-A gRPC server that facilitates provisioning and updating containers
+A gRPC server that facilitates provisioning and updating containers.
+
+## Usage
+### List USB Devices
+Replace IP address accordingly.
+```bash
+grpcurl -plaintext -import-path ./proto -proto ormos.proto -d '{}' '10.0.0.42:50052' unit.containers.v0.Ormos.ListUsbDevices
+```
+
+Example output (device not mounted):
+```json
+{
+  "devices": [
+    {
+      "devicePath": "/dev/sda"
+    },
+    {
+      "devicePath": "/dev/sda1"
+    }
+  ]
+}
+```
+
+Example output (device mounted):
+```json
+{
+  "devices": [
+    {
+      "devicePath": "/dev/sda"
+    },
+    {
+      "devicePath": "/dev/sda1",
+      "isMounted": true,
+      "mountPoint": "/mnt/usb"
+    }
+  ]
+}
+```
-- 
cgit v1.2.3