summaryrefslogtreecommitdiff
path: root/rust/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'rust/README.md')
-rw-r--r--rust/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/rust/README.md b/rust/README.md
new file mode 100644
index 0000000..8f2c1b9
--- /dev/null
+++ b/rust/README.md
@@ -0,0 +1,20 @@
+# auth-xmppessage
+
+### Compile
+
+It's written in rust, compile it with `cargo build`
+
+### Run
+
+```
+Usage: ./target/debug/auth_xmppmessage [options]
+
+Options:
+ -j, --jid JID bot jid
+ -p, --password PASSWORD
+ bot password
+ -u, --user USER add valid user
+ -s, --secret SECRET server secret for token generation
+ -t, --time HOURS Validity of the token in hours (default 48)
+ -h, --help print this help menu
+``` \ No newline at end of file