From a83913e24c239a09e8f003025371bdc7cf5fee2c Mon Sep 17 00:00:00 2001
From: Green Sky <green@g-s.xyz>
Date: Mon, 16 Jan 2023 23:25:23 +0100
Subject: [PATCH] barebones readme

---
 src/states/README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 src/states/README.md

diff --git a/src/states/README.md b/src/states/README.md
new file mode 100644
index 0000000..9226a18
--- /dev/null
+++ b/src/states/README.md
@@ -0,0 +1,40 @@
+# Tool to send and receive files using Tox NGC FileTransfers
+currently on prototype FT1
+
+## Usage
+
+```
+$ tox_ngc_ft1_tool
+~~~ HELP ~~~
+ meta:
+ -v version info
+ -V verbose
+ -h help
+
+ connectivity:
+ -G <chat_id>
+ -F profile.tox
+ -N <self_name> (defaults to 'tox_ngc_ft1_tool')
+ will print friend id at startup
+ will autoaccept any invite
+ if no -F given, will not save profile.
+ if profile exists load, otherwise create new
+
+ transfer variant:
+ -a id1/sha1_single/sha1_info/sha2_single/sha2_info
+
+ send:
+ -f send_this_file.zip
+
+ receive:
+ -d dump/everything/in/this/dir
+ -D <id/hash> (what to dl)
+
+!!! ADVANCED !!!
+ tox:
+ -L disable local discovery
+ -U disable udp
+ -P proxy_host proxy_port
+ -p tox_port (bind tox to that port)
+```
+