summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorLi Zhineng <[email protected]>2025-07-15 21:41:08 +0800
committerGitHub <[email protected]>2025-07-15 21:41:08 +0800
commitd2e00b7d1897ba2940784526172e43e5fea689d3 (patch)
tree6bf3f905dc13df991c1793ec4c9c69c0fb5e9b62 /README.md
parent458fa767414ee16fc7ddb1636bad12bd317d5d28 (diff)
parent25d41704b64a8eabe0310807d2819f574fac6b5e (diff)
downloadsetup-d2e00b7d1897ba2940784526172e43e5fea689d3.tar.gz
setup-d2e00b7d1897ba2940784526172e43e5fea689d3.zip
Merge pull request #2 from openairmx/docs
Paperwork
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6a95e8a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Set up your AIRMX Pro
+
+A device setup page for AIRMX Pro that utilizes the Web Bluetooth API.
+This setup allows users to reconnect the device to the internet now that
+AIRMX has ceased operations.
+
+Since we cannot modify the hostname of the MQTT server during the setup
+process, please note that we need to remap the domain name __i.airmx.cn__
+to our local computing server on your router. Feel free to check out the
+server code in a dedicated [repository](https://github.com/openairmx/server).
+
+## License
+
+The project is released under [the MIT license](LICENSE.md).