Initial commit

addons/netfox.noray/README.md

@@ -0,0 +1,39 @@
+# netfox.noray
+
+Bulletproof your connectivity with [netfox]'s [noray] integration!
+
+## Features
+
+* 🤝 Establish connectivity using NAT punchthrough
+  * Uses [noray] for orchestration
+  * Implements a full UDP handshake
+* 🛜 Use [noray] as a relay
+  * Useful in cases where NAT punchthrough fails
+  * If you can see this repo, you probably can connect through [noray]
+
+## Install
+
+See the root [README](../../README.md).
+
+> *Note*, that while *netfox.noray* is part of the *netfox* suite, it can be
+> used alone, without installing *netfox* itself.
+
+## Usage
+
+See the [docs](https://foxssake.github.io/netfox/netfox.noray/guides/noray/).
+
+For a full example, see [noray-bootstrapper.gd].
+
+## License
+
+netfox.noray is under the [MIT license](LICENSE).
+
+## Issues
+
+In case of any issues, comments, or questions, please feel free to [open an issue]!
+
+[netfox]: https://github.com/foxssake/netfox
+[source]: https://github.com/foxssake/netfox/archive/refs/heads/main.zip
+[noray]: https://github.com/foxssake/noray
+[noray-bootstrapper.gd]: ../../examples/shared/scripts/noray-bootstrapper.gd
+[open an issue]: https://github.com/foxssake/netfox/issues