Skip to content

Commit 50b7cc5

Browse files
README --> modules menu added.
1 parent e74969d commit 50b7cc5

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ npm install puddysql
4040

4141
## 📚 Documentation
4242

43-
To learn more about each module (`Engine`, `Instance`, `Query`, `Tags`) and how they work together:
43+
For API reference, check each module’s own documentation:
4444

4545
👉 **See:** [`docs/README.md`](./docs/README.md)
4646

@@ -67,6 +67,25 @@ To learn more about each module (`Engine`, `Instance`, `Query`, `Tags`) and how
6767

6868
---
6969

70+
## 🧭 Modules Menu
71+
72+
The `PuddySql` class is the main access point to all core features of the library.
73+
You should not instantiate it directly — instead, use `PuddySql.Instance`.
74+
75+
Here's a quick overview of what's available:
76+
77+
| 📦 Static Property | 🔍 Description |
78+
| ------------------- | --------------------------------------------------------------------------- |
79+
| `PuddySql.Instance` | 🎮 Main SQL client class for managing databases (PostgreSQL or SQLite3) |
80+
| `PuddySql.Query` | 🧠 Query builder and smart search engine with advanced filtering |
81+
| `PuddySql.Tags` | 🏷️ Flexible tag system parser (with support for JSON arrays, boosts, etc.) |
82+
| `PuddySql.Events` | 🎯 Event manager to attach lifecycle hooks to query logic |
83+
| `PuddySql.Utils` | 🛠️ Useful utilities (object flattening, merge helpers, SQL formatters) |
84+
| `PuddySql.pg` | 🐘 PostgreSQL database engine (pg wrapper) |
85+
| `PuddySql.sqlite3` | 📀 SQLite3 engine for local/in-memory usage (sqlite3 wrapper) |
86+
87+
---
88+
7089
## 🚀 Quick Example
7190

7291
Here’s how to get started using **PuddySQL**:

0 commit comments

Comments
 (0)