diff --git a/README.md b/README.md index a2552af..43c67c3 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,56 @@ - - # MokoJoomHero -A Joomla Module developed following MokoStandards. +A Joomla Module designed to provide a random image from a folder with content on top as a Hero. -[![License](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](LICENSE) +![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-MokoJoomHero-blue?style=flat-square) -## Overview -This is a standardized Joomla module that conforms to Moko Consulting's development standards and best practices. It provides a consistent starting point with pre-configured tooling, documentation structure, and development workflows. +A Joomla Module designed to provide a random image from a folder with content on top as a Hero. -## Features +| Field | Value | +|---|---| +| **Language** | Markdown | +| **License** | GPL-3.0-or-later | +| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero) | -- **Standardized Structure**: Pre-organized directories for source code, documentation, and scripts -- **Build Automation**: Makefile with common tasks (lint, build, package, install) -- **Code Quality**: Pre-configured PHP linting and CodeSniffer for Joomla standards -- **Development Tools**: EditorConfig for consistent coding styles across IDEs -- **Documentation**: Template structure following MokoStandards documentation practices -- **Git Configuration**: Pre-configured git attributes, ignore patterns, and commit message templates +--- -## Prerequisites +## Guides -- **PHP**: 7.4 or higher (8.0+ recommended for Joomla 4.x/5.x) -- **Joomla**: A working Joomla installation for testing (3.x, 4.x, or 5.x) -- **Make**: GNU Make for running build commands +| Page | Description | +|---|---| +| [FIREWALL_CONFIGURATION](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero/wiki/FIREWALL_CONFIGURATION) | This document provides guidance on configuring firewalls to allow the automated license download wor... | +| [QUICKSTART](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero/wiki/QUICKSTART) | This guide helps you get started with the manual GPL license sync workflow that downloads and mainta... | -## Installation +## Documentation -1. Build the module package: - ```bash - make build - ``` +| Page | Description | +|---|---| +| [IMPLEMENTATION_SUMMARY](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero/wiki/IMPLEMENTATION_SUMMARY) | This implementation adds automated GPL-3.0 license download functionality with comprehensive firewal... | +| [update server](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero/wiki/update-server.-.-) | This document explains how `update.xml` is automatically managed for this Joomla extension following... | -2. Upload the generated ZIP file via Joomla's Extension Manager +--- -## Usage +> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home) -```bash -# Display available commands -make help +--- -# Validate code -make validate -# Build module package -make build -``` -## Project Structure +--- -``` -. -├── docs/ # Documentation files -├── scripts/ # Build and deployment scripts -├── src/ # Module source code -├── Makefile # Build automation -└── README.md # This file -``` +## Documentation + +Full documentation is available on the [Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomHero/wiki). ## Contributing -We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. - -## Versioning - -This project uses [Semantic Versioning](https://semver.org/). - -See [CHANGELOG.md](CHANGELOG.md) for version history. +See the wiki for development guidelines and contribution instructions. ## License -Copyright (C) 2026 Moko Consulting +This project is licensed under the GNU General Public License v3.0 or later -- see the [LICENSE](LICENSE) file. -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. +--- -SPDX-License-Identifier: GPL-3.0-or-later - -## Support - -- **Documentation**: See the [docs/](docs/) directory -- **Contact**: hello@mokoconsulting.tech -- **Website**: [mokoconsulting.tech](https://mokoconsulting.tech) +*[Moko Consulting](https://mokoconsulting.tech) -- [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*