From dfe4f5cca5c7c36da9485261fe0eb4a55e47a158 Mon Sep 17 00:00:00 2001
From: Dmitry <b4tm4n@mail.ru>
Date: Thu, 17 Aug 2023 23:26:18 +0300
Subject: [PATCH] add README.md

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7751312
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# socks5ws
+
+app for running SOCKS5 server as windows service
+
+currently used:
+
+- [fast-socks5](https://github.com/dizda/fast-socks5) - socks5 server lib
+- [windows-service](https://github.com/mullvad/windows-service-rs) - windows service lib
+
+## Usage
+
+use subcommands:
+
+- `install`
+- `uninstall`
+- `start`
+- `stop`
+
+and:
+
+- `save-config` - save default config to a file in .exe folder
+- `serve` - run server as foreground proccess
+
+don't use `run`, this is for windows, as service entrypoint