Skip to content

Commit 89fe443

Browse files
committed
Shortening package name, fixing bin installation
1 parent 4859d69 commit 89fe443

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
1-
# @observablehq/observable-database-proxy
1+
# @observablehq/database-proxy
22

3-
The database proxy is a simple webserver that accepts secure requests from your Observable notebooks, and proxies queries to a PostgreSQL or MySQL database — one that is not necessarily exposed to the web. You can use the database proxy to securely connect to databases on your local computer, on an intranet or within a VPN.
3+
The database proxy is a simple Node.js webserver that accepts secure requests from your Observable notebooks, and proxies queries to a PostgreSQL or MySQL database — one that is not necessarily exposed to the web. You can use the database proxy to securely connect to databases on your local computer, on an intranet or within a VPN.
44

55
## Installation
66

7-
You can use `npx` to try out the database proxy as a one-off:
7+
Install the database proxy locally or globally with `npm` or `yarn`:
88

99
```
10-
npx @observablehq/observable-database-proxy <name>
11-
```
12-
13-
Or install it globally with `npm` or `yarn`:
14-
15-
```
16-
npm install -g @observablehq/observable-database-proxy
17-
yarn global add @observablehq/observable-database-proxy
10+
npm install -g @observablehq/database-proxy
11+
yarn global add @observablehq/database-proxy
1812
```
1913

2014
## Running the database proxy

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
{
2+
"bin": {
3+
"observable-database-proxy": ".bin/observable-database-proxy"
4+
},
25
"dependencies": {
36
"JSONStream": "^1.3.5",
47
"esm": "^3.2.25",
@@ -10,10 +13,9 @@
1013
"serialize-error": "^4.1.0",
1114
"yargs": "^13.2.4"
1215
},
13-
"name": "observable-database-proxy",
16+
"name": "@observablehq/database-proxy",
1417
"description": "A local proxy to connect private Observable notebooks to private databases",
1518
"version": "1.0.0",
16-
"main": "index.js",
1719
"devDependencies": {
1820
"nodemon": "^1.19.1"
1921
},

0 commit comments

Comments
 (0)