datapeek 0.1.11 → 0.1.13

package/README.md

@@ -1,8 +1,18 @@
 <img src="https://raw.githubusercontent.com/bishoymly/datapeek/main/public/assets/logo.png" alt="Datapeek Logo" width="200" />
 
-**A modern, local SQL database browser for MS SQL Server databases.**
+**A modern, local SQL database browser for SQL Server and PostgreSQL databases.**
 
-Datapeek provides an intuitive web-based interface to browse, query, and explore your SQL Server databases directly from your terminal.
+Datapeek provides an intuitive web-based interface to browse, query, and explore your SQL Server and PostgreSQL databases directly from your terminal.
+
+## Screenshots
+
+### Light Mode
+![Datapeek Light Mode](https://raw.githubusercontent.com/bishoymly/datapeek/main/public/screenshots/light1.png)
+![Datapeek Light Mode](https://raw.githubusercontent.com/bishoymly/datapeek/main/public/screenshots/light2.png)
+
+### Dark Mode
+![Datapeek Dark Mode](https://raw.githubusercontent.com/bishoymly/datapeek/main/public/screenshots/dark1.png)
+![Datapeek Dark Mode](https://raw.githubusercontent.com/bishoymly/datapeek/main/public/screenshots/dark2.png)
 
 ## Quick Start
 
@@ -10,10 +20,16 @@ Datapeek provides an intuitive web-based interface to browse, query, and explore
 
 Run Datapeek with your connection string directly:
 
+**SQL Server:**
 ```bash
 npx datapeek "Server=localhost;Database=MyDB;User Id=sa;Password=password;"
 ```
 
+**PostgreSQL:**
+```bash
+npx datapeek "postgresql://user:password@localhost:5432/mydb"
+```
+
 This will automatically connect and open your browser to the Datapeek interface.
 
 ### Option 2: Without Connection String
@@ -28,15 +44,19 @@ A connection dialog will open in your browser where you can enter your database
 
 ## Features
 
-- 🗄️ **Browse Tables** - Explore database schemas and tables with an intuitive sidebar
-- 📊 **View Data** - Paginated table views with Excel-like cell selection and copy
-- 🔍 **Search & Filter** - Quickly find tables and data
-- 📝 **SQL Editor** - Write and execute queries with syntax highlighting
+- 🗄️ **Multi-Database Support** - Works with both SQL Server and PostgreSQL
+- 📊 **Browse Tables** - Explore database schemas and tables with an intuitive sidebar
+- 📋 **View Data** - Paginated table views with Excel-like cell selection and copy
+- 🔍 **Search & Filter** - Quickly find tables and data with advanced filtering
+- 📝 **SQL Editor** - Write and execute queries with syntax highlighting and query history
+- 🔗 **Foreign Key Navigation** - View related data with foreign key displays
+- 📦 **JSON Support** - View and explore JSON objects with expandable formatting
 - ⭐ **Favorites** - Bookmark frequently used tables
-- 💾 **Connection History** - Recent connections are remembered
+- 💾 **Connection History** - Recent connections are remembered per database
 - 🎨 **Modern UI** - Clean, responsive interface
 - 🌓 **Dark Mode** - Built-in theme toggle
 - 📋 **Copy to Excel** - Select cells and copy with headers (Ctrl+C)
+- ⏱️ **Query Cancellation** - Cancel long-running queries (30-minute timeout)
 
 ## Installation (Optional)
 
@@ -48,10 +68,16 @@ npm install -g datapeek
 
 Then run it directly:
 
+**SQL Server:**
 ```bash
 datapeek "Server=localhost;Database=MyDB;User Id=sa;Password=password;"
 ```
 
+**PostgreSQL:**
+```bash
+datapeek "postgresql://user:password@localhost:5432/mydb"
+```
+
 ## Development
 
 For developers who want to contribute or customize Datapeek:
@@ -67,9 +93,12 @@ npm install
 # Run development server (opens browser automatically)
 npm run dev
 
-# Run with connection string
+# Run with connection string (SQL Server)
 CONNECTION_STRING="Server=localhost;Database=MyDB;User Id=sa;Password=password;" npm run dev
 
+# Run with connection string (PostgreSQL)
+CONNECTION_STRING="postgresql://user:password@localhost:5432/mydb" npm run dev
+
 # Build for production
 npm run build
 ```
@@ -77,7 +106,7 @@ npm run build
 ## Requirements
 
 - Node.js 18 or higher
-- MS SQL Server database (local or remote)
+- SQL Server database (local or remote) **OR** PostgreSQL database (local or remote)
 
 ## License