summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJokler <jokler.contact@gmail.com>2020-01-06 00:27:29 +0100
committerJokler <jokler@protonmail.com>2020-01-06 00:29:58 +0100
commit1b2a791b5a01155a8f5f87f0d9dd066ab9ff9c44 (patch)
treefb7d50268096aed0513d8751b76f818a0b71368d
parent219ac9cb92be0a83f11a736105981ffdcf9f23b4 (diff)
downloadpokebot-1b2a791b5a01155a8f5f87f0d9dd066ab9ff9c44.tar.gz
pokebot-1b2a791b5a01155a8f5f87f0d9dd066ab9ff9c44.zip
Add readme and update e-mail
-rw-r--r--Cargo.toml2
-rw-r--r--README.md18
2 files changed, 19 insertions, 1 deletions
diff --git a/Cargo.toml b/Cargo.toml
index d5fcf9f..f82b234 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,7 +1,7 @@
[package]
name = "pokebot"
version = "0.1.0"
-authors = ["Jokler <jokler.contact@gmail.com>"]
+authors = ["Jokler <jokler@protonmail.com>"]
edition = "2018"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3a2f752
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# pokebot
+
+```
+pokebot 0.1.0
+Jokler <jokler@protonmail.com>
+
+USAGE:
+ pokebot [FLAGS] [OPTIONS]
+
+FLAGS:
+ -h, --help Prints help information
+ -V, --version Prints version information
+ -v, --verbose Print the content of all packets
+
+OPTIONS:
+ -a, --address <address> The address of the server to connect to [default: localhost]
+ -i, --id <id_path> Identity file - good luck creating one
+```