add docs

Author: mweinschenk

README.md

@@ -24,26 +24,35 @@ php artisan vendor:publish --tag="laravel-evm-config"
 
 
 ## env
- EVM_CHAIN_ID=137
- EVM_RPC_1=https://polygon-mainnet.g.alchemy.com/v2/KEY
- EVM_PRIVATE_KEY=0xabc123...64hex
- QUEUE_CONNECTION=redis
+```dotenv
+EVM_CHAIN_ID=137
+EVM_RPC_1=https://polygon-mainnet.g.alchemy.com/v2/KEY
+EVM_PRIVATE_KEY=0xabc123...64hex
+QUEUE_CONNECTION=redis
+```
 
-## Usage
+## Usage (Quick Glimpse)
 
 ```php
 use LaravelEvm; // Facade alias defined in composer.json
 
-$abi = file_get_contents(storage_path('app/abi/IntegrityAnchorSimple.abi.json'));
+$abi = file_get_contents(storage_path('app/abi/MyContract.abi.json'));
 $contract = LaravelEvm::at('0xYourContract', $abi);
 
-// read
-$res = $contract->call('isAnchored', [1, '0x'.$hashHex]);
+// Read call
+$balance = $contract->call('balanceOf', ['0xUser']);
+
+// Write (async)
+$jobId = $contract->sendAsync('transfer', ['0xRecipient', 100]);
+```
 
-// write non blocking
-$jobId = $contract->sendAsync('anchor', [1, '0x'.$hashHex, 'meta']);
+Wait for a known tx hash:
+```php
+$receipt = $contract->wait('0xTxHash');
 ```
 
+More examples & full documentation: See the VitePress docs in `docs/pages` or visit the published site.
+
 ### Generate new addresses
 
 The package ships with a helper to generate fresh Ethereum keypairs (using `kornrunner/ethereum-address`).
@@ -74,6 +83,28 @@ Sample JSON response:
 
 Security note: Private keys are shown once. Persist them securely (e.g. Vault, KMS). Never commit them.
 
+### Facades Overview
+
+Facade aliases (registered in `composer.json`):
+
+| Facade | Binding |
+|--------|---------|
+| `LaravelEvm` | ContractClient |
+| `EvmContract` | ContractClient |
+| `EvmRpc` | RpcClient |
+| `EvmSigner` | Signer |
+| `EvmFees` | FeePolicy |
+| `EvmNonce` | NonceManager |
+
+Example usage:
+```php
+$symbol = \LaravelEvm::at('0xContract', $abi)->call('symbol');
+$health = \EvmRpc::health();
+$address = \EvmSigner::getAddress();
+// Suggest fees (implement suggest() if missing in your FeePolicy)
+// $fees = \EvmFees::suggest();
+```
+
 ## Testing
 
 ```bash

docs/.gitignore

@@ -0,0 +1,11 @@
+*.log
+*.tgz
+.DS_Store
+.idea
+.temp
+.vite_opt_cache
+.vscode
+dist
+cache
+temp
+node_modules

docs/.vitepress/config.mts

@@ -0,0 +1,66 @@
+import { defineConfig } from 'vitepress';
+
+export default defineConfig({
+  title: 'Laravel EVM',
+  description: 'Reliable EVM interaction for Laravel (contracts, async transactions, fees, nonces, multi-RPC)',
+  srcDir: '.',
+  outDir: '../build/docs',
+  cleanUrls: true,
+  lastUpdated: true,
+  themeConfig: {
+    nav: [
+      { text: 'Guide', link: '/pages/README' },
+      { text: 'Architecture', link: '/pages/architecture' },
+      { text: 'Configuration', link: '/pages/configuration' },
+      { text: 'Transactions', link: '/pages/transactions' },
+      { text: 'Events', link: '/pages/events' },
+  { text: 'Facades', link: '/pages/facades' },
+  { text: 'Examples', link: '/pages/examples' }
+    ],
+    sidebar: {
+      '/pages/': [
+        {
+          text: 'Overview',
+          items: [
+            { text: 'Introduction', link: '/pages/README#introduction' },
+            { text: 'Quick Start', link: '/pages/README#quick-start' },
+            { text: 'Core Concepts', link: '/pages/README#core-concepts' }
+          ]
+        },
+        {
+          text: 'Architecture',
+          items: [
+            { text: 'Component Diagram', link: '/pages/architecture#component-diagram' },
+            { text: 'Transaction Lifecycle', link: '/pages/architecture#transaction-job-lifecycle' },
+            { text: 'Events', link: '/pages/events' }
+          ]
+        },
+        {
+          text: 'Runtime',
+          items: [
+            { text: 'Configuration', link: '/pages/configuration' },
+            { text: 'Facades', link: '/pages/facades' },
+            { text: 'Transactions', link: '/pages/transactions' },
+            { text: 'Events', link: '/pages/events' },
+            { text: 'Examples', link: '/pages/examples' }
+          ]
+        },
+        {
+          text: 'Advanced',
+          items: [
+            { text: 'Extensibility Points', link: '/pages/architecture#extensibility-points' },
+            { text: 'Concurrency Model', link: '/pages/architecture#concurrency-model' },
+            { text: 'Security Considerations', link: '/pages/architecture#security-considerations' }
+          ]
+        }
+      ]
+    },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/farbcodegmbh/laravel-evm' }
+    ],
+    footer: {
+      message: 'MIT Licensed',
+      copyright: 'Copyright © 2025 Farbcode GmbH'
+    }
+  }
+});