Merge pull request #2 from openairmx/docs

Paperwork

2 files changed, 35 insertions, 0 deletions

diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..25e5857
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zhineng Li
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
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).