From 197640771c92c74d26668fc5a0cb3368e8957529 Mon Sep 17 00:00:00 2001
From: Misha Kaletsky <mmkal@users.noreply.github.com>
Date: Thu, 21 Mar 2024 09:31:01 -0400
Subject: [PATCH] restore readme

---
 packages/admin/readme.md | 46 ++++++++++++++++++++++++++--------------
 1 file changed, 30 insertions(+), 16 deletions(-)

diff --git a/packages/admin/readme.md b/packages/admin/readme.md
index ebe1b6cb..3d618932 100644
--- a/packages/admin/readme.md
+++ b/packages/admin/readme.md
@@ -13,7 +13,8 @@ A no-config admin UI for running queries against PostgreSQL database, with autoc
    - [What about pgAdmin](#what-about-pgadmin)
 - [Get started](#get-started)
 - [Use as a library](#use-as-a-library)
-   - [Auth](#auth)
+- [Deployment](#deployment)
+- [Auth](#auth)
 - [👽 Future](#-future)
 <!-- codegen:end -->
 
@@ -50,31 +51,44 @@ You can install and run either globally or locally.
 
 Globally:
 
-```bash
-import {appRouter, clientMiddleware} from '@pgkit/admin'
-import {createClient} from '@pgkit/client'
-import {createExpressMiddleware} from '@trpc/server/adapters/express'
-UI. When developing against a local databse, this is all you'll need to do.
+<!-- eslint-disable @typescript-eslint/no-unused-vars -->
 
-## Use as a library
+```
+npm install --global @pgkit/admin
+pgkit-admin
+```
 
-```ts
-import {appRouter, clientMiddleware} from '@pgkit/admin'
-import {createClient} from '@pgkit/client'
-import {createExpressMiddleware} from '@trpc/server/adapters/express'
-ou would like to deploy the UI - for example, to an internal admin site - you can use it as a library from node.js. You can import a middleware for the API, and for the client static files, or there's a [trpc](https://trpc.io) router:
+Locally:
+
+```
+npm install @pgkit/admin
+npx pgkit-admin
+```
+
+You can then set the `connection-string` header in the UI. When developing against a local databse, this is all you'll need to do.
+
+## Use as a library
 
 ```ts
-import {apiMiddleware, clientMiddleware} from '@pgkit/admin'
+import {getExpressRouter} from '@pgkit/admin'
 import express from 'express'
 
 const app = express()
 
-app.use(clientMiddleware)
-app.use(apiMiddleware)
+app.use(getExpressRouter())
+
+app.listen(5050)
 ```
 
-### Auth
+## Deployment
+
+If you would like to deploy the UI - for example, to an internal admin site - you can use it as a library from node.js. You can import a middleware for the API, and for the client static files, or there's a [trpc](https://trpc.io) router:
+
+```ts
+import {appRouter, clientMiddleware} from '@pgkit/admin'
+import {createClient} from '@pgkit/client'
+import {createExpressMiddleware} from '@trpc/server/adapters/express'
+## Auth
 
 Auth isn't built in, but is easy to add using almost any auth solution for node.js. @pgkit/admin can run against a local database with no setup needed. If you want to use it against a production database, you are responsible for authenticating database calls.