chore: Better readme for both WP and GitHub

Author: itssimple

Gulpfile.js

@@ -6,7 +6,7 @@ const pinfo = require("./package.json");
 
 gulp.task("readme-version", function () {
     return gulp
-        .src("src/README.md")
+        .src("src/readme.*")
         .pipe(replace("$PLUGINVERSION$", pinfo.version))
         .pipe(replace("$PLUGINATLEAST$", pinfo.config.eduadmin.requiresAtLeast))
         .pipe(replace("$PLUGINTESTEDTO$", pinfo.config.eduadmin.testedUpTo))
@@ -34,7 +34,7 @@ gulp.task("plugin-version", function () {
 
 gulp.task("default", function () {
     gulp.watch("src/eduadmin-google.php", gulp.series("plugin-version"));
-    gulp.watch("src/README.md", gulp.series("readme-version"));
+    gulp.watch("src/readme.*", gulp.series("readme-version"));
     gulp.watch(
         "package.json",
         gulp.series("readme-version", "plugin-version")

README.md

@@ -0,0 +1,23 @@
+# EduAdmin - Google Analytics / Tag Manager
+
+- Tags: booking, participants, courses, events, eduadmin, lega online, google, analytics, tag manager
+- Requires at least: 5.8
+- Tested up to: 6.4
+- Stable tag: 1.0.0
+- Requires PHP: 7.0
+- License: GPL3
+- License-URI: https://www.gnu.org/licenses/gpl-3.0.en.html
+
+## Description
+
+This plugin adds support for Google Analytics / Tag Manager to
+your [EduAdmin-Wordpress plugin](https://github.com/MultinetInteractive/EduAdmin-WordPress).
+
+The plugin will add javascript to your website that will send events to Google Analytics / Tag Manager when a user
+interacts with the booking form.
+
+The domain of the javascript will be from https://www.googletagmanager.com, and you can find their terms of service
+here:
+https://www.google.com/analytics/terms/tag-manager/
+
+This plugin requires that you're using the [EduAdmin-Wordpress plugin](https://wordpress.org/plugins/eduadmin-booking/)

readme.md

@@ -42,6 +42,7 @@ rm -fR "$PROJECT_ROOT"/scripts
 rm -fR "$PROJECT_ROOT"/.git
 rm -fR "$PROJECT_ROOT"/node_modules
 rm -fR "$PROJECT_ROOT"/src
+rm -fR "$PROJECT_ROOT"/readme.md
 
 # Make sure we are in the project root
 cd "$PROJECT_ROOT"

scripts/github-deploy.sh

@@ -0,0 +1,23 @@
+# EduAdmin - Google Analytics / Tag Manager
+
+- Tags: booking, participants, courses, events, eduadmin, lega online, google, analytics, tag manager
+- Requires at least: $PLUGINATLEAST$
+- Tested up to: $PLUGINTESTEDTO$
+- Stable tag: $PLUGINVERSION$
+- Requires PHP: $PLUGINREQUIREDPHP$
+- License: GPL3
+- License-URI: https://www.gnu.org/licenses/gpl-3.0.en.html
+
+## Description
+
+This plugin adds support for Google Analytics / Tag Manager to
+your [EduAdmin-Wordpress plugin](https://github.com/MultinetInteractive/EduAdmin-WordPress).
+
+The plugin will add javascript to your website that will send events to Google Analytics / Tag Manager when a user
+interacts with the booking form.
+
+The domain of the javascript will be from https://www.googletagmanager.com, and you can find their terms of service
+here:
+https://www.google.com/analytics/terms/tag-manager/
+
+This plugin requires that you're using the [EduAdmin-Wordpress plugin](https://wordpress.org/plugins/eduadmin-booking/)