version.php readme changelog

CHANGELOG.md

@@ -0,0 +1,12 @@
+CHANGELOG
+=========
+
+4.5.1 (2024-12-03)
+------------------
+* [FIX] #31 Lang file (en) sorted alphabetically
+
+
+4.5.0 (2024-11-12)
+------------------
+Moodle 4.5 compatible version
+

README.md

@@ -1,5 +1,18 @@
-Chunk upload moodleform-element (moodle-local_chunkupload)
-=====================
+# moodle-local_chunkupload - Chunk upload moodleform element #
+
+This plugin offers a new form element for moodle forms to upload one file as multiple chunks.
+
+This file is part of the mod_opencast plugin for Moodle - <http://moodle.org/>
+
+*Maintainer:*   Thomas Niedermaier (Universität Münster), Farbod Zamani (Elan e.V.)
+
+*Copyright:* 2024 Thomas Niedermaier, UNIVERSITÄT MÜNSTER
+
+*License:*   [GNU GPL v3 or later](http://www.gnu.org/copyleft/gpl.html)
+
+
+Description
+-----------
 
 This plugin offers a new form element for moodle forms.
 The form element is a file upload field, which uploads one file as multiple small chunks.
@@ -20,12 +33,16 @@ Picture of the chunkupload while uploading a file.
 Installation
 ------------
 
-To install the plugin you have to place the content of this repository into local/chunkupload.
+* Copy the module code directly to the local/chunkupload directory.
+
+* Log into Moodle as administrator.
+
+* Open the administration area (http://your-moodle-site/admin) to start the installation
+  automatically.
 
-`git clone https://github.com/learnweb/moodle-local_chunkupload.git local/chunkupload.`
-
-Usage
------
+
+Usage in your plugin
+--------------------
 
 To use the form element within one of your plugins, you first have to register the form element as a quickform element:
 
@@ -42,7 +59,31 @@ $mform->addElement('chunkupload', 'video_chunk', get_string('myvideo', 'myplugin
         array('maxbytes' => $maxuploadsize, 'accepted_types' => $videotypes));
 ```
 
-The form element takes in two parameters, which can specify the maximum upload size (`maxbytes`) and the accepted filetypes (`accepted_types`). 
+The form element takes in two parameters, which can specify the maximum upload size (`maxbytes`) and the accepted filetypes (`accepted_types`).
+
+
+Admin Settings
+--------------
+
+View the documentation of the plugin settings ("additional features") [here](https://moodle.docs.opencast.org/#block/additional_features/).
+
+
+## Documentation ##
+
+The full documentation of the plugin can be found [here](https://moodle.docs.opencast.org/#chunkupload/about/).
+
+
+Bug Reports / Support
+---------------------
+
+We try our best to deliver bug-free plugins, but we can not test the plugin for every platform,
+database, PHP and Moodle version. If you find any bug please report it on
+[GitHub](https://github.com/Opencast-Moodle/moodle-local_chunkupload/issues). Please
+provide a detailed bug description, including the plugin and Moodle version and, if applicable, a
+screenshot.
+
+You may also file a request for enhancement on GitHub.
+
 
 ## License ##
 

version.php

@@ -26,7 +26,8 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = 'local_chunkupload';
-$plugin->release = 'v4.5-r1';
-$plugin->version = 2024111100;
+$plugin->release = 'v4.5-r2';
+$plugin->version = 2024111101;
 $plugin->requires = 2024100700; // Requires Moodle 4.5+.
+$plugin->supported = [405, 405];
 $plugin->maturity = MATURITY_STABLE;