summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCircleShift <kgunger12@gmail.com>2024-05-01 05:43:56 +0000
committerCircleShift <kgunger12@gmail.com>2024-05-01 05:43:56 +0000
commit94e364b4dcfe4e8685cfc42ccde40856ff992eda (patch)
tree7f1e66b420294b6fb746937c95bacbcf08661cf8
parent0c1b29f06ddcfda2cf47461f846ddee0a320567d (diff)
Update README.md
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index abffc24..9fdd232 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
-# libopensmarts
-
-Utility library for creating and interacting with OpenSmarts compatible devices on embedded linux \ No newline at end of file
+# libopensmarts
+
+Utility library for creating and interacting with OpenSmarts compatible devices on embedded linux
+
+By default, OSm devices are either onboard, or networked. If onboard in an embedded linux environment, they should advertise themselves as a socket under the /run/osm/onboard directory. If on the network, they are accessable via port 1313.