Initial commit

1 files changed, 51 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..caf0951
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# Authorization by direct link
+
+Authorization plugin for Moodle.
+Adds the ability to authorize a user by a direct link.
+
+<a name="installation">
+    <h2>Installation</h2>
+</a>
+Get the installation package in any of the available methods:
+
+* [GitHub Releases](https://github.com/valentineus/auth-link/releases).
+* [Compilation from the source code](#build).
+
+In Moodle in the administration panel go to the "Plugins" section and make a standard installation of the plug-in.
+
+<a name="using">
+    <h2>Using</h2>
+</a>
+Pass the variables `username` and `password` in any standard way.
+Variables are read from a file `$ _REQUEST`, which guarantees GET and POST requests performance, as well as support for the cookie.
+
+Example of a link that authorizes a user on the course:
+```
+https://yourwebserver.org/course/view.php?id=2&username=guest&password=qwerty
+```
+
+<a name="build">
+    <h2>Build</h2>
+</a>
+Self-assembly package is as follows:
+
+* Clone the repository:
+```bash
+git clone https://github.com/valentineus/auth-link.git auth-link
+```
+
+* Run the build script:
+```bash
+cd ./auth-link
+/bin/sh build.sh
+```
+
+<a name="license">
+    <h2>License</h2>
+</a>
+
+<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