summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Gunger <kgunger12@gmail.com>2024-05-01 01:44:21 -0400
committerKyle Gunger <kgunger12@gmail.com>2024-05-01 01:44:21 -0400
commit21938c4ed611cd0945d62502abdb74527a533e78 (patch)
treed0f77289f63e3b5a30f7832d0e484d9b8aef7f92
parent1dcd0f2efb6ecb2d4cbcd7302179c3b48b5c8c23 (diff)
parentd792ba35d3a6c6a293d6c1da4281b4ec643f457e (diff)
Merge branch 'main' of git.cshift.net:OpenSmarts/libopensmarts
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index abffc24..821679f 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`.