Release v2.0: namespace/Grammar refactor, query/schema fixes, soft-delete, pivot, aggregates

.gitattributes

@@ -3,5 +3,10 @@
 
 /.vscode       export-ignore
 lefthook.yml export-ignore
+.php-cs-fixer.php export-ignore
 .gitattributes export-ignore
-.gitignore export-ignore
+.gitignore export-ignore
+/tests export-ignore
+/docs export-ignore
+phpunit.xml export-ignore
+phpcs.xml export-ignore

.gitignore

@@ -2,4 +2,7 @@ vendor/
 .php-cs-fixer.cache
 tests.config.php
 .phpunit.result.cache
+.phpunit.cache/
+phpunit.phar
 composer.lock
+.superpowers/

README.md

@@ -1,22 +1,49 @@
-### WPKit/Database
+# wp-database
 
----
+A small ActiveRecord ORM with a fluent query and schema builder on top of
+WordPress' `$wpdb`.
 
-# usage
+## Install
 
-1. Add this repository in composer.json
+```jsonc
+// composer.json
+"repositories": [
+  { "type": "vcs", "url": "https://github.com/Bit-Apps-Pro/wp-database" }
+]
+```
 
+```bash
+composer require bitapps/wp-database:dev-main
 ```
-"repositories": [
+
+## Quick start
+
+```php
+use BitApps\WPDatabase\Model;
+
+class Contact extends Model
+{
+    protected $fillable = ['name', 'email'];
+
+    public function deals()
     {
-      "type": "vcs",
-      "url": "https://github.com/Bit-Apps-Pro/wp-database"
+        return $this->hasMany(Deal::class, 'contact_id', 'id');
     }
-  ]
-```
+}
 
-2. Then install the package
+Contact::insert(['name' => 'Ada', 'email' => 'ada@x.com']);
 
+$active = Contact::where('is_active', 1)
+    ->withCount('deals')
+    ->orderBy('name')->asc()
+    ->get();                       // Collection of Contact models
 ```
-composer require bitapps/wp-database:dev-main
-```
+
+## Documentation
+
+- **[Usage guide](docs/usage.md)** — models, query builder, relationships,
+  casts, events, transactions, and more.
+- **[Relationships](docs/relations.md)** — `hasOne`/`belongsTo`/`hasMany`/`belongsToMany`,
+  eager & lazy loading, relation aggregates, and limitations.
+- **[Schema builder](docs/schema.md)** — table creation, columns, indexes, and migrations.
+- **[Breaking changes](docs/breaking-changes.md)** — upgrade notes.

composer.json

@@ -29,29 +29,34 @@
     ]
   },
   "require": {
-    "php": "^7.4 || ^8.0"
+    "php": ">=8.2"
   },
   "autoload": {
     "psr-4": {
       "BitApps\\WPDatabase\\": "./src"
     }
   },
   "scripts": {
+    "test": "phpunit",
     "lint": "./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php",
-    "compat": "./vendor/bin/phpcs -p ./src --standard=PHPCompatibilityWP --runtime-set testVersion 7.4-"
+    "compat": "./vendor/bin/phpcs -p ./src --standard=PHPCompatibilityWP --runtime-set testVersion 8.2-"
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.10",
     "sirbrillig/phpcs-variable-analysis": "*",
     "dealerdirect/phpcodesniffer-composer-installer": "^0.7",
-    "phpcompatibility/phpcompatibility-wp": "*"
+    "phpcompatibility/phpcompatibility-wp": "*",
+    "phpunit/phpunit": "^11.5"
   },
   "extra": {
     "branch-alias": {
       "dev-main": "1.x-dev"
     }
   },
   "config": {
+    "platform": {
+      "php": "8.2.0"
+    },
     "allow-plugins": {
       "dealerdirect/phpcodesniffer-composer-installer": true
     }