diff --git a/readme.md b/readme.md index 564ab96733..bc428ab8ea 100644 --- a/readme.md +++ b/readme.md @@ -1,82 +1,39 @@ -markdown# EpicNabbo Catalogue v2 +# EpicNabbo Catalogue v2 (In Development 🛠️) +EpicNabbo Catalogue v2 is a complete, ground-up rewrite of the original catalog system. Version 1 suffered from architectural bottlenecks due to an incorrect development approach. Version 2 rectifies these mistakes, delivering a highly optimized, clean database structure. +> ⚠️ **Status: Work In Progress (WIP)** +> This project is currently under active development. Features are being implemented rapidly using our new, corrected methodology. It is not yet ready for production use. -EpicNabbo Catalogue v2 is a complete, ground-up rewrite of the original catalog system. Version 1 suffered from architectural bottlenecks due to an inefficient development approach. Version 2 rectifies these mistakes, delivering a highly optimized, 100% complete database structure with zero missing pages and massive performance gains. - - - -\## 🚀 Key Improvements over v1 - - - -\* \*\*100% Complete:\*\* All pages, tabs, and sub-items are fully implemented. Absolutely zero missing pages. - -\* \*\*Blazing Fast:\*\* Re-engineered from scratch. v2 loads and renders significantly faster than v1 due to an optimized indexing strategy. - -\* \*\*Superior Structure:\*\* Clean, logical database relationships and structured category trees replace the messy approach of the previous version. - -\* \*\*Rapid Development:\*\* Built using a corrected, streamlined methodology, making deployment and customization much faster. - - - -\## 🛠️ Features - - - -\* Full catalog page coverage with perfect hierarchy. - -\* Optimized SQL queries for minimal server load. - -\* Pre-sorted and categorized furniture/item structures. - -\* Lightweight and clean code architecture. - - - -\## 📦 Installation - - - -1\. Clone this repository into your project directory: - - ```bash - - git clone gitlab.com - - ``` - -2\. Import the latest database structure from the `/sql` directory into your database. - -3\. Configure your emulator or content management system to point to the new catalog tables. - -4\. Restart your server environment to apply changes. - - - -\## 📈 Comparison - +## 🚀 Key Objectives & Improvements over v1 +* **100% Complete Goal:** Built to ensure all pages, tabs, and sub-items are fully implemented. Zero missing pages upon final release. +* **Blazing Fast:** Re-engineered from scratch. v2 loads and renders significantly faster than v1 due to an optimized indexing strategy. +* **Superior Structure:** Clean, logical database relationships and structured category trees replace the messy, unorganized approach of the previous version. +* **Faster Development Cycle:** By fixing our initial approach, development is moving much faster than v1, despite being built from the ground up. +## 📈 Comparison (Targeted Outcomes) | Feature | Version 1 (Old) | Version 2 (New) | - | :--- | :--- | :--- | +| **Status** | Completed (Flawed) | **In Active Development** 🛠️ | +| **Completeness** | Missing pages & broken links | 100% Complete (No missing pages) | +| **Performance** | Slow loading / poor queries | Blazing fast architecture | +| **Database Structure** | Unorganized / brute-forced | Clean, indexed, and modular | +| **Development Speed**| Slow due to troubleshooting | Near-instant deployment | -| \*\*Completeness\*\* | Missing pages \& broken links | 100% Complete \& verified | +## 🛠️ Current Roadmap -| \*\*Performance\*\* | Slow loading / poor queries | Blazing fast architecture | +- [x] Analyze v1 bottlenecks and fix core architecture. +- [/] Rebuild database schema and indexing structure (In Progress). +- [ ] Port catalog pages to the new layout. +- [ ] Final testing and verification (Zero missing pages check). -| \*\*Database Structure\*\* | Unorganized / brute-forced | Clean, indexed, and modular | - -| \*\*Setup Time\*\* | Lengthy due to troubleshooting | Near-instant deployment | - - - -\## 📄 License - - - -This project is licensed under the MIT License - see the \[LICENSE](LICENSE) file +## 📦 Installation (Development Preview) +1. Clone this repository: + ```bash + git clone gitlab.com + ``` +2. Check the active development branches for the latest updates. \ No newline at end of file