summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2021-01-29 16:29:47 +0100
committerxengineering <mail2xengineering@protonmail.com>2021-01-29 16:32:46 +0100
commit73dcb4a3b31bc5a0496a65b88074785ecaf3344a (patch)
treef73c983ef9db2ceb41d91111cf7a4a008b513f85 /README.md
parente0bcf5c439c831b23fb924f53a39a61ae9363e2f (diff)
downloadxbot-73dcb4a3b31bc5a0496a65b88074785ecaf3344a.tar
xbot-73dcb4a3b31bc5a0496a65b88074785ecaf3344a.tar.zst
xbot-73dcb4a3b31bc5a0496a65b88074785ecaf3344a.zip
Add existing Files
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5ddaf7d..ed604ab 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
+
# xbot
-A Software to create simpel Chat Bots for the XMPP/Jabber Protocol. \ No newline at end of file
+A Software to create simpel Chat Bots for the XMPP/Jabber Protocol.
+
+## Current State
+
+This software is not ready to use. The first milestone is a simple terminal application which sends a message on a command like this:
+
+```
+xbot -m "Hello from your XMPP bot" -j "recipient@example.com" -p /path/to/my/xmpp/profile.ini
+```
+
+Have a look at ```example_profile.ini``` to see how your own JID and password have to be formalized.
+