docs: update README from wiki Home

2026-05-10 18:39:24 +00:00
parent cf28c4b31e
commit 0db469fe82
1 changed files with 48 additions and 84 deletions
@@ -1,92 +1,56 @@
-<!-- Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
+# MokoJoomTOS

- This file is part of a Moko Consulting project.
+A component to present a sites Term of Service and privacy policy even through offline.

- SPDX-License-Identifier: GPL-3.0-or-later
+![Language](https://img.shields.io/badge/Markdown-000000?style=flat-square&logo=markdown&logoColor=white) ![License](https://img.shields.io/badge/license-GPL--3.0--or--later-green?style=flat-square) ![Wiki](https://img.shields.io/badge/wiki-MokoJoomTOS-blue?style=flat-square)

- # FILE INFORMATION
- REPO: https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS
- FILE: ./README.md
- VERSION: 03.08.05
- BRIEF: MokoJoomTOS - Offline Access Plugin for Joomla
- -->

-# MokoJoomTOS - Offline Access Plugin for Joomla
+A component to present a sites Term of Service and privacy policy even through offline.

-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
-[![Joomla](https://img.shields.io/badge/Joomla-4.x%20%7C%205.x-blue.svg)](https://www.joomla.org/)
-[![Enterprise Ready](https://img.shields.io/badge/Enterprise-Ready-success.svg)](#enterprise-features-)
-
-A lightweight Joomla system plugin that allows your Terms of Service (or any other legal document) to remain accessible even when your site is in offline/maintenance mode.
-
-## Features
-
- **Simple & Lightweight** - Just a single plugin, no component needed
- **Native Joomla Integration** - Uses standard Joomla articles and menus
- **Slug-Based Access** - Configure which menu slug remains accessible when offline
- **Zero Database Impact** - No custom tables or migrations
- **Automatic Setup** - Creates article, menu, and configuration automatically
- **Enterprise Ready** - Secure, scalable, and compliant with best practices
- **Component View** - Displays TOS without template chrome during offline mode
-
-## How It Works
-
-1. **Install the plugin** - Upload and install the ZIP file
-2. **Automatic setup** - Plugin creates article and Legal menu automatically
-3. **Pre-configured** - Terms of Service is ready at `/terms-of-service`
-4. **Visitors can view** legal documents even during site maintenance
-
-## Installation
-
-### From Release (Recommended)
-
-1. Download the latest `plg_system_mokojoomtos-x.x.x.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS/releases)
-2. In Joomla admin, go to **System > Install > Extensions**
-3. Upload the ZIP file
-4. **That's it!** The plugin automatically configures itself.
-
-## Configuration
-
-The plugin has just ONE configuration field:
-
-| Field | Description | Default |
-|-------|-------------|---------|
-| **Terms of Service Menu Slug** | The menu item alias that should remain accessible when site is offline | `terms-of-service` |
-
-## Requirements
-
- Joomla 4.0 or later
- PHP 7.4 or later
-
-## License
-
-GNU General Public License v3.0 or later
-
-See [LICENSE](LICENSE) file for details.
-
-## Author
-
-**Moko Consulting**
-
- Website: [https://mokoconsulting.tech](https://mokoconsulting.tech)
- Email: hello@mokoconsulting.tech
-
-## Changelog
-
-### Version 03.08.05 (2026-04-23)
-
- Patch bump for release pipeline fixes
-
-### Version 03.08.04 (2026-02-28)
-
- Fixed template chrome loading issue
- Component-only view now properly applied in offline mode
- Event hook changed from onAfterInitialise to onAfterRoute
-
-### Version 1.0.0 (2026-02-27)
-
- Initial release
+| Field | Value |
+|---|---|
+| **Language** | Markdown |
+| **License** | GPL-3.0-or-later |
+| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS) |

 ---

-**Made with love by Moko Consulting**
+## Guides
+
+| Page | Description |
+|---|---|
+| [Configuration](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS/wiki/Configuration) | MokoJoomTOS has a minimal configuration surface -- just one parameter controls which page remains ac... |
+| [Installation](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS/wiki/Installation) | Step-by-step guide to installing the MokoJoomTOS offline access plugin for Joomla. |
+
+## Documentation
+
+| Page | Description |
+|---|---|
+| [How It Works](How-It-Works.-) | MokoJoomTOS is a Joomla system plugin that intercepts requests during offline mode and selectively a... |
+| [update server](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS/wiki/update-server.-.-) | This document explains how `update.xml` is automatically managed for this Joomla extension following... |
+
+---
+
+> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)
+
+---
+
+
+
+---
+
+## Documentation
+
+Full documentation is available on the [Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomTOS/wiki).
+
+## Contributing
+
+See the wiki for development guidelines and contribution instructions.
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 or later -- see the [LICENSE](LICENSE) file.
+
+---
+
+*[Moko Consulting](https://mokoconsulting.tech) -- [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*