@pgplex/pgconsole 0.1.1 → 0.2.0

package/README.md

@@ -1,42 +1,31 @@
 # pgconsole
 
-Postgres Editor with Guardrails.
+Web-based PostgreSQL editor. Single binary, single config file, no database required. Connect your team to PostgreSQL with access control and audit logging built in.
 
-## Development
+## Features
 
-### Prerequisites
-
-- Node.js 20+
-- pnpm
-- PostgreSQL
+- Full PostgreSQL parser powers realtime autocomplete, syntax highlighting, and error detection
+- Query, edit results, stage changes, and apply — all in one view
+- AI assistant generates SQL, explains queries, fixes errors, and assesses change risk
+- Fine-grained IAM controls who can read, write, or administer each connection
+- Every query and login is recorded in the audit log
+- Everything is in `pgconsole.toml` — connections, users, groups, access rules, AI providers
 
-### Setup
+## Installation
 
-1. Install dependencies:
-   ```bash
-   pnpm install
-   ```
-
-2. Copy environment variables:
-   ```bash
-   cp .env.example .env
-   ```
+### Prerequisites
 
-3. Configure your database connection in `.env`
+- Node.js 20+
 
-4. Run database migrations:
-   ```bash
-   pnpm db:push
-   ```
+### npm
 
-5. Start the development server:
-   ```bash
-   pnpm dev
-   ```
+```bash
+npm install -g @pgplex/pgconsole
+pgconsole --config pgconsole.toml
+```
 
-## Tech Stack
+### npx
 
-- **Frontend**: React 19, TypeScript, Tailwind CSS v4
-- **Backend**: Express, ConnectRPC
-- **Database**: PostgreSQL with Drizzle ORM
-- **Build**: Vite (rolldown-vite)
+```bash
+npx @pgplex/pgconsole --config pgconsole.toml
+```