Update README.md

Author: PhMemmel

README.md

@@ -1 +1,53 @@
-# moodle-mod_aichat
+# moodle-mod_aichat - Chat Frontend for local_ai_manager as activity
+
+The plugin "mod_aichat" provides a chatbot as a course activity.
+
+It depends on block_ai_chat and basically wrapps an block_ai_chat instance in an activity. 
+
+# Settings
+
+## Requirements
+
+https://github.com/bycs-lp/moodle-block_ai_chat, https://github.com/bycs-lp/moodle-local_ai_manager and https://github.com/bycs-lp/moodle-tiny_ai need to be installed.
+
+## Installing via uploaded ZIP file ##
+
+1. Log in to your Moodle site as an admin and go to _Site administration >
+   Plugins > Install plugins_.
+2. Upload the ZIP file with the plugin code. You should only be prompted to add
+   extra details if your plugin type is not automatically detected.
+3. Check the plugin validation report and finish the installation.
+
+## Installing manually ##
+
+The plugin can be also installed by putting the contents of this directory to
+
+    {your/moodle/dirroot}/blocks/ai_chat
+
+Afterwards, log in to your Moodle site as an admin and go to _Site administration >
+Notifications_ to complete the installation.
+
+Alternatively, you can run
+
+    $ php admin/cli/upgrade.php
+
+to complete the installation from the command line.
+
+## License ##
+
+2026, ISB Bayern
+
+Lead developer: Philipp Memmel <philipp.memmel@mailbox.org>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.