aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorValentin Popov <info@valentineus.link>2017-12-11 06:47:51 +0300
committerValentin Popov <info@valentineus.link>2017-12-11 06:47:51 +0300
commite0e9322644bf8153ce28791295ece3f8705825f3 (patch)
tree0f553e4260565f80522302b50cd51a32bcb02242 /README.md
parent7278ee951bd8b62fea96b59ad79be694088e7849 (diff)
downloadlocal_webhooks-e0e9322644bf8153ce28791295ece3f8705825f3.tar.xz
local_webhooks-e0e9322644bf8153ce28791295ece3f8705825f3.zip
Additions to the description file
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 4 insertions, 20 deletions
diff --git a/README.md b/README.md
index c8fcae6..4bb97dd 100644
--- a/README.md
+++ b/README.md
@@ -20,27 +20,11 @@ Features:
* Use a secret phrase to authenticate requests;
* [JSON](https://en.wikipedia.org/wiki/JSON) - Format of outgoing data;
-## Installation
+## Documentation
-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
-```
+* [Install the plugin](docs/getting-started.md#installation).
+* [User guide](docs/getting-started.md#user-guide).
+* [Request format](docs/getting-started.md#request-format).
## License