From e52dcc5c6bab167468d2dd5dd222531cca3ce963 Mon Sep 17 00:00:00 2001
From: lordtet <lordtet@foxcarries.me>
Date: Mon, 11 Aug 2025 21:28:24 -0400
Subject: [PATCH] Initial commit!

---
 README.md    | 11 ++++++++++-
 lua/shim.lua |  1 +
 py/shim.py   |  1 +
 3 files changed, 12 insertions(+), 1 deletion(-)
 create mode 100644 lua/shim.lua
 create mode 100644 py/shim.py

diff --git a/README.md b/README.md
index 7e5a2c6..9ad3274 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,12 @@
 # MC_BBS
 
-Access OpenComputers (minecraft) functionality via serial
\ No newline at end of file
+Access OpenComputers (minecraft) functionality via serial interface.
+## Features
+Includes:
+- A python shim to allow OpenComputers to act as a "server" with a client socket
+- A Lua BBS server to be used in an OpenComputers machine
+
+## Usage
+Move the contents of lua/ to an OpenComputers disk, run the BBS with your shim server address as an argument
+Move the contents of py/ to a real world server of your choice and run `shim.py`.
+Point a tcpser instance at the shim and let it fly!
diff --git a/lua/shim.lua b/lua/shim.lua
new file mode 100644
index 0000000..f556aa8
--- /dev/null
+++ b/lua/shim.lua
@@ -0,0 +1 @@
+-- Placeholder!
diff --git a/py/shim.py b/py/shim.py
new file mode 100644
index 0000000..09fd402
--- /dev/null
+++ b/py/shim.py
@@ -0,0 +1 @@
+#Placeholder!