summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorunitexe <unitexe70@gmail.com>2025-06-07 21:56:56 -0500
committerunitexe <unitexe70@gmail.com>2025-06-07 21:56:56 -0500
commit1ad4faefea45f1d3bfe4475dbcf1497a507c99bc (patch)
tree08d75729dbdcd7eb58dae7431c6c829850493b0f /README.md
parent0ee55c3362abf1f7bf8dc4e5de161f1ba8c97ec1 (diff)
Add usage documentation to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 38 insertions, 1 deletions
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"
+ }
+ ]
+}
+```