diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..755b1c5 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ + + +# Changelog + +## [Unreleased] + +### Added +- **Repository** — initial repo creation with dev branch, topics, workflows +- **Roadmap Issue** — implementation roadmap with full feature checklist diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..8c69ced --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,31 @@ +# MokoSuiteLibrary + +Library and resource lending management for Joomla 6 — catalog, checkout, returns, reservations, overdue tracking, fines, OPAC. + +## Quick Reference + +| Field | Value | +|---|---| +| **Package** | `pkg_mokosuitelibrary` | +| **Layer** | 2 (requires: Client → CRM) | +| **Language** | PHP 8.3+ | +| **Branch** | develop on `dev`, merge to `main` (protected) | +| **Wiki** | [MokoSuiteLibrary Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteLibrary/wiki) | + +## Architecture + +Joomla **package** — Layer 2 add-on. CRM contacts serve as library patrons. + +## Rules + +- **Never commit** `.claude/`, `.mcp.json`, `TODO.md`, `*.min.css`/`*.min.js` +- **Attribution**: `Authored-by: Moko Consulting` +- **Workflow directory**: `.mokogitea/` +- **Standards**: [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/MokoCLI/wiki) +- **Changelog**: `[Unreleased]` only — release system assigns versions + +## Coding Standards + +- PHP 8.3+ / Joomla 6 patterns +- `$this->getDatabase()` in models, `Factory::getContainer()->get(DatabaseInterface::class)` in helpers +- `Factory::getApplication()->getIdentity()` for user diff --git a/README.md b/README.md index 9c7b300..15bb6b2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ -# MokoSuiteLibrary +# MokoSuite Library -Library and resource lending management for Joomla 6 — catalog, checkout, returns, reservations, overdue tracking, fines \ No newline at end of file +Library and resource lending management for Joomla 6 — catalog, checkout, returns, reservations, overdue tracking, fines. + +**Layer 2** add-on for [MokoSuite](https://git.mokoconsulting.tech/MokoConsulting). Standalone (optional CRM integration for patron contacts). + +## Links + +- [Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteLibrary/wiki) · [Issues](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteLibrary/issues) · [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteLibrary/releases) + +GPL-3.0-or-later · Copyright © 2026 [Moko Consulting](https://mokoconsulting.tech)