diff --git a/README.md b/README.md index de9b1a3..5741276 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,42 @@ -# SpeedBB Forum +# speedBB -Placeholder README for the forum application. +speedBB is a modern forum application with a built-in Admin Control Panel (ACP), customizable branding, user/rank management, attachment support, and integrated update tooling. -## Status +## What It Does -Work in progress. +- Hosts classic forum discussions with categories, forums, topics, and replies. +- Provides an ACP for everyday operations (settings, users, groups, ranks, attachments, and audit log). +- Supports brand customization (name, theme, accents, logos, favicons). +- Manages user media (avatars, rank badges, logos) with public delivery. +- Includes built-in update and system-check workflows so admins can verify server health and apply updates from the ACP. + +## ACP Areas + +The ACP is organized into practical sections for day-to-day forum operations: + +- `General`: core board identity and visual setup (name, theme defaults, accents, logos, favicons). +- `Forums`: structure and ordering of categories/forums. +- `Users`: account overview and moderation/admin user management actions. +- `Groups`: role and permission group administration. +- `Ranks`: rank definitions and badge management. +- `Attachments`: attachment policy and extension/group controls. +- `Audit log`: activity trail for administrative actions. +- `System`: environment checks and update operations. +- `Custom`: space for project-specific custom assets/overrides. + +### System + +The System area is split into two focused views: + +- `Health`: shows whether the live website environment is healthy enough to run reliably. +- `Updates`: provides update-related checks and update actions, including CLI interpreter validation. + +This separation is intentional: +- `Health` answers “Is the site healthy right now?” +- `Updates` answers “Is this server ready to run update operations?” + +## Current Product Status + +- Active version: `26.0.3` +- Forum + ACP features are in active use. +- Health and update checks are integrated directly into ACP System. diff --git a/composer.json b/composer.json index 4c17230..1650141 100644 --- a/composer.json +++ b/composer.json @@ -98,5 +98,5 @@ "minimum-stability": "stable", "prefer-stable": true, "version": "26.0.3", - "build": "106" + "build": "107" }