dzql 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,12 +4,10 @@ PostgreSQL-powered framework with automatic CRUD operations and real-time WebSoc
4
4
 
5
5
  ## Documentation
6
6
 
7
- All documentation is maintained in the repository root:
8
-
9
- - **[README.md](../../README.md)** - Project overview and quick start
10
- - **[GETTING_STARTED.md](GETTING_STARTED.md)** - Complete tutorial with working todo app
11
- - **[REFERENCE.md](REFERENCE.md)** - Complete API reference
12
- - **[CLAUDE.md](../../docs/CLAUDE.md)** - Development guide for AI assistants
7
+ - **[Getting Started Guide](docs/GETTING_STARTED.md)** - Complete tutorial with working todo app
8
+ - **[API Reference](docs/REFERENCE.md)** - Complete API documentation
9
+ - **[Compiler Documentation](docs/compiler/)** - Entity compilation guide and coding standards
10
+ - **[Claude Guide](docs/CLAUDE.md)** - Development guide for AI assistants
13
11
  - **[Venues Example](../venues/)** - Full working application
14
12
 
15
13
  ## Quick Install
@@ -33,6 +31,23 @@ const user = await ws.api.save.users({ name: 'Alice' });
33
31
  const results = await ws.api.search.users({ filters: { name: 'alice' } });
34
32
  ```
35
33
 
34
+ ## DZQL Compiler
35
+
36
+ Transform declarative entity definitions into optimized PostgreSQL stored procedures:
37
+
38
+ ```bash
39
+ # Via CLI
40
+ dzql compile database/init_db/009_venues_domain.sql -o compiled/
41
+
42
+ # Programmatically
43
+ import { DZQLCompiler } from 'dzql/compiler';
44
+
45
+ const compiler = new DZQLCompiler();
46
+ const result = compiler.compileFromSQL(sqlContent);
47
+ ```
48
+
49
+ See **[Compiler Documentation](docs/compiler/)** for complete usage guide, coding standards, and advanced features.
50
+
36
51
  ## License
37
52
 
38
53
  MIT