summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..69068ad
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Moodle WebHook's
+
+Webhooks allow applications to subscribe to Moodle events.
+
+**Attention!**:
+This plugin is in active development.
+
+## Installation
+
+Get the installation package in any of the available methods:
+
+* [GitHub Releases](https://github.com/valentineus/moodle-webhooks/releases).
+* [Compilation from the source code](#build).
+
+## Build
+
+Self-assembly package is as follows:
+
+* Clone the repository:
+```bash
+git clone https://github.com/valentineus/moodle-webhooks.git moodle-webhooks
+```
+
+* Run the build script:
+```bash
+cd ./moodle-webhooks
+/bin/sh build.sh
+```
+
+## License
+
+<img height="256px" alt="GNU Banner" src="https://www.gnu.org/graphics/runfreegnu.png" />
+
+[GNU GPLv3](LICENSE.txt).
+Copyright (c)
+[Valentin Popov](mailto:info@valentineus.link). \ No newline at end of file