diff --git a/README.md b/README.md new file mode 100644 index 0000000..15c5327 --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +
+
+ # koridor
+
+ **VPN over your own SSH server.**
+
+ [](#about)
+ []()
+ []()
+
+
+
+
+### Linux · Windows
+
+Releases are published on the [Releases](../../releases) page.
+
+### macOS · iOS
+
+Coming soon.
+
+## Architecture
+
+```
+Flutter UI (Dart)
+ │
+FFI (cdylib)
+ │
+koridor engine (Rust)
+ ├── TUN device
+ ├── smoltcp netstack (packets → TCP flows)
+ ├── russh SSH client (direct-tcpip per flow)
+ └── Route manager
+```
+
+Each TCP flow captured off the TUN device is proxied over its own SSH `direct-tcpip` channel — the same kind of traffic an ordinary SSH port-forward produces, indistinguishable on the wire from routine SSH use.
+
+## Security
+
+- Your SSH private key and passphrase are stored only in the OS secure credential store (Android Keystore / platform-equivalent) and are only ever sent to the server you configure, as part of establishing the tunnel.
+- All traffic between client and server is carried inside the SSH transport.
+
+See the [Privacy Policy](privacy-policy.md) for full details on what koridor does and does not process.
+
+## Support & Contributing
+
+**Bug reports and vulnerabilities:** contact the maintainer directly via the address shown in the app's About screen.
+
+**Contributing:** core development is handled internally. We do not currently accept external pull requests.
+
+---
+
+## About
+
+Created by **Eugen Kaparulin**.
+Official binaries distributed by **[K-Ops Oy](https://k-ops.eu)**.
+
+© Eugen Kaparulin. All rights reserved.
+[Privacy Policy](privacy-policy.md)