summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index b8e56c8..c2bb9a0 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,17 @@ BlaEars
=======
It's called BlaEars because it listens for HTTP requests. Get it?
+
+This is used for listening for HTTP requests on specified URLs, and then
+doing something with them - specifically, sending messages to IRC (at
+the moment)
+
+Current supported URLs -
+
+/git/push
+Listens for GitLab messages announcing pushes to repositories
+
+/git/merge
+Listens for GitLab messages announcing merge requests
+
+Uses Spring MVC and SpringBoot