Add README.md

2026-03-04 21:42:44 +00:00
parent d15470de67
commit 9793d340cd
1 changed files with 52 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,52 @@
+diff --git a/c:\Users\johna\AppData\Roaming\Code\User\globalStorage\humy2833.ftp-simple\remote-workspace-temp\b242d35761bdd94475435af3d5f1a382\public_html\dev/README.md b/c:\Users\johna\AppData\Roaming\Code\User\globalStorage\humy2833.ftp-simple\remote-workspace-temp\b242d35761bdd94475435af3d5f1a382\public_html\dev/README.md
+new file mode 100644
+--- /dev/null
+++ b/c:\Users\johna\AppData\Roaming\Code\User\globalStorage\humy2833.ftp-simple\remote-workspace-temp\b242d35761bdd94475435af3d5f1a382\public_html\dev/README.md
+@@ -0,0 +1,47 @@
+# AudioCore V1.5
+
+AudioCore V1.5 is a modular CMS for labels, artists, releases, storefront sales, and support workflows.
+
+It is built around a plugin-first architecture so core stays clean while features can be enabled/disabled per site.
+
+## Key features
+
+- Modular plugin system (enable/disable from admin)
+- Artists plugin (profiles, socials, artist pages)
+- Releases plugin (catalog pages, release detail, track metadata, samples)
+- Store plugin (cart, checkout, PayPal, orders, customers, discounts, downloads)
+- Support plugin (ticketing, IMAP reply sync, admin replies)
+- Newsletter module (subscriber management + templates)
+- Media library (upload and reuse media across modules)
+- Page builder + shortcode support
+- Maintenance/coming-soon controls
+- Update checker from Gitea manifest
+
+## Tech overview
+
+- PHP 8.3+
+- MySQL/MariaDB
+- OpenLiteSpeed/Apache compatible routing via `.htaccess`
+- Server cron integration for background jobs (IMAP sync, chart refresh)
+
+## Install (high level)
+
+1. Upload project files.
+2. Point web root to `dev/` (or deploy repo to desired root).
+3. Open `/admin` to run installer.
+4. Enter database + admin details.
+5. Configure SMTP and run test email.
+6. Enable required plugins and create their tables.
+
+## Recommended production setup
+
+- Keep private download storage outside public web root.
+- Use HTTPS only.
+- Configure SMTP correctly for transactional mail.
+- Configure cron jobs in Admin > Cron Jobs.
+- Keep `storage/` writable and secured.
+
+## Release notes source
+
+Updates are controlled via `update.json` in this repository and checked from admin Updates page.
+