added content to readme.md

6 years ago · 1eaa78d92a
parent af0a2e0ce0
commit 1eaa78d92a
1 changed files with 58 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,60 @@
 # drone-sendxmpp

+Drone plugin for sending messages to Jabber accounts, using [sendxmpp](http://sendxmpp.hostname.sk/)
+
+![](https://drone.bunix.de/api/badges/bunix42/drone-sendxmpp/status.svg)
+[![](https://images.microbadger.com/badges/version/bunix42/drone-sendxmpp.svg)](https://microbadger.com/images/bunix42/drone-sendxmpp "Get your own version badge on microbadger.com")
+[![](https://images.microbadger.com/badges/image/bunix42/drone-sendxmpp.svg)](https://microbadger.com/images/bunix42/drone-sendxmpp "Get your own image badge on microbadger.com")
+[![](https://img.shields.io/docker/pulls/bunix42/drone-sendxmpp.svg)](https://hub.docker.com/r/bunix42/drone-sendxmpp/)
+
+# Usage
+
+## prerequisites
+
+you obviously need a valid jabber account to send messages, this can be your own account or a dedicated one just for your drone notifications.
+
+## standalone using docker
+
+```
+docker run
+  -e PLUGIN_USERNAME=someaccount
+	-e PLUGIN_JSERVER=jabberserver.invalid
+	-e SENDXMPP_PASSWORD=secret1234
+	-e PLUGIN_RECIPIENT=someone@jabberserver.invalid
+	bunix42/drone-sendxmpp
+```
+
+## drone pipeline
+
+```
+pipeline:
+  sendxmpp:
+    image: bunix42/drone-sendxmpp
+    pull: true
+    recipient: someone@jabberserver.invalid
+    jserver: jabberserver.invalid
+    secrets: [ sendxmpp_username, sendxmpp_password ]
+```
+
+### secret reference
+
+* `sendxmpp_username` username without domain part used for authentication
+* `sendxmpp_password` password used for authentication
+
+### parameter reference
+
+* `recipient` jabber id of the account to receive the message
+* `jserver` jabberserver of the sending account
+* `username` username to use for authentication (_better use drone secrets_)
+* `password` password to use for authentication (_better use drone secrets_)
+
+# TODO's
+
+* support for self-signed certificate authorities and common ca's (_currently tls validation is disabled_)
+* support for sending messages to chat rooms instead of single users
+* customizable message template (_currently its only `repo:tag/branch:status:link`_)
+
+# References
+
+* [sendxmpp](http://sendxmpp.hostname.sk/) is used for sending messages
+* [shunit2](https://github.com/kward/shunit2) is used for script testing