final touches

ronneycz · Apr 27, 2022 · b990a22 · b990a22
1 parent 8cbcb7f
commit b990a22
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
 # xaseco-quotes
+
+**A TrackMania XASECO plugin**
+
+Allows to invoke random quotes using `/quote` command.
+
+Provides easy maintenance of quotes inside xml config file and possibility to add or modify quotes without restarting XASECO using `/quote reload` command - as MasterAdmin.
+
+## Installation
+
+1. extract the plugin to XASECO base directory
+2. set up at least 2 quotes in `quotes.xml` to make use of the plugin
+3. edit plugins.xml and include the following line: `<plugin>plugin.quotes.php</plugin>`
+4. restart XASECO
diff --git a/plugins/plugin.quotes.php b/plugins/plugin.quotes.php
@@ -1,5 +1,20 @@
 <?php
 
+/*
+================================================================================
+Description:    Allows to invoke random quotes using /quote command.
+                Provides easy maintenance of quotes inside xml config file and
+                possibility to add or modify quotes without restarting XASECO
+                using /quote reload command - as MasterAdmin.
+
+Author:         ronney
+Version:        v1.0
+Date:           2022-04-27
+
+Dependencies:   none
+================================================================================
+*/
+
 Aseco::registerEvent('onSync', 'q_onSync');
 Aseco::addChatCommand('quote', 'Tells a random quote from this server');