Revert "fix npm pkg issues"

This reverts commit 66752bd.
f0rr0 · Nov 19, 2024 · ecce7b7 · ecce7b7
1 parent 66752bd
commit ecce7b7
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -9,13 +9,18 @@ This allows you to:
 ## How it Works
 
 The proxy creates two servers:
-1. A WebSocket server (port 443) that communicates with the database instance in the browser
-2. A TCP server (port 5432) that accepts standard PostgreSQL client connections
+1. A WebSocket server that communicates with the database instance in the browser
+2. A TCP server that accepts standard PostgreSQL client connections
 
 When a PostgreSQL client connects to the TCP server, the proxy:
 1. Forwards the client's messages to the browser through WebSocket
 2. Returns the browser's responses back to the client through TCP
 
+### Examples
+
+- [PGlite + Drizzle](https://github.com/f0rr0/pg-browser-proxy/tree/main/examples/pglite-drizzle)
+- [PGlite + Prisma](https://github.com/f0rr0/pg-browser-proxy/tree/main/examples/pglite-prisma)
+
 ## Usage
 
 ### 1. Install the Packages
@@ -31,6 +36,16 @@ Using bunx:
 bunx pg-browser-proxy
 ```
 
+To use custom ports:
+```sh
+bunx pg-browser-proxy -t 5433 -w 8080
+```
+
+See all options:
+```sh
+bunx pg-browser-proxy -h
+```
+
 ### 3. Connect Your Database Instance
 
 ```typescript
@@ -45,11 +60,13 @@ const db = await PGliteWorker.create(
 
 // Connect to the proxy in development
 if (process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test") {
-  connectProxy((message) => db.execProtocolRaw(message));
+  connectProxy((message) => db.execProtocolRaw(message), {
+    wsPort: 443, // optional, defaults to 443
+  });
 }
 ```
 
-The key requirement is that your database must expose be able handle raw [Postgres wire protocol](https://www.postgresql.org/docs/current/protocol.html) messages.
+The key requirement is that your database must be able to handle raw [Postgres wire protocol](https://www.postgresql.org/docs/current/protocol.html) messages.
 
 ### 4. Connect with PostgreSQL Tools
 
@@ -78,11 +95,6 @@ export default defineConfig({
 
 - Only one browser connection is allowed at a time
 
-### Examples
-
-- [PGlite + Drizzle](git+https://github.com/f0rr0/pg-browser-proxy.git/tree/main/examples/pglite-drizzle)
-- [PGlite + Prisma](git+https://github.com/f0rr0/pg-browser-proxy.git/tree/main/examples/pglite-prisma)
-
 ## Further Reading
 
 - [pg-gateway](https://github.com/supabase-community/pg-gateway) - Built on top of this project

diff --git a/package.json b/package.json
@@ -14,13 +14,13 @@
     "prisma",
     "studio"
   ],
-  "homepage": "git+https://github.com/f0rr0/pg-browser-proxy.git#readme",
+  "homepage": "https://github.com/f0rr0/pg-browser-proxy#readme",
   "bugs": {
-    "url": "git+https://github.com/f0rr0/pg-browser-proxy.git/issues"
+    "url": "https://github.com/f0rr0/pg-browser-proxy/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/f0rr0/pg-browser-proxy.git"
+    "url": "https://github.com/f0rr0/pg-browser-proxy"
   },
   "funding": {
     "type": "github",

diff --git a/packages/pg-browser-proxy/package.json b/packages/pg-browser-proxy/package.json
@@ -32,11 +32,11 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+git+https://github.com/f0rr0/pg-browser-proxy.git.git"
+    "url": "https://github.com/f0rr0/pg-browser-proxy"
   },
-  "homepage": "git+https://github.com/f0rr0/pg-browser-proxy.git#readme",
+  "homepage": "https://github.com/f0rr0/pg-browser-proxy#readme",
   "bugs": {
-    "url": "git+https://github.com/f0rr0/pg-browser-proxy.git/issues"
+    "url": "https://github.com/f0rr0/pg-browser-proxy/issues"
   },
   "funding": {
     "type": "github",
@@ -73,11 +73,11 @@
       "types": "./dist/browser/index.d.ts"
     },
     "./proxy": {
-      "import": "./dist/proxy/proxy.js",
-      "types": "./dist/proxy/proxy.d.ts"
+      "import": "./bin/src/proxy.js",
+      "types": "./bin/src/proxy.d.ts"
     }
   },
   "bin": {
-    "pg-browser-proxy": "bin/bin.js"
+    "pg-proxy": "./bin/src/cli/bin.js"
   }
 }
diff --git a/packages/pg-browser-proxy/src/cli/help.ts b/packages/pg-browser-proxy/src/cli/help.ts
@@ -30,7 +30,7 @@ const command: GluegunCommand = {
     $ pg-proxy --tcp-port 5433 --ws-port 8080
     
   ${chalk.bold("Documentation:")}
-    ${chalk.blue("git+https://github.com/f0rr0/pg-browser-proxy.git#readme")}
+    ${chalk.blue("https://github.com/f0rr0/pg-browser-proxy#readme")}
   
   ${chalk.bold("Environment Variables:")}
     ${chalk.dim("DEBUG")}    Enable debug logs (e.g., DEBUG=pg-proxy:*)