Skip to content

Commit 90a3eb2

Browse files
committed
remove configuration options from docs
1 parent 50792cb commit 90a3eb2

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/installation.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,30 @@ cd pg_graphql
88
cargo pgrx install --release
99
```
1010

11-
Before enabling the extension in PostgreSQL, you need to initialize `pgrx`. Depending on your PostgreSQL installation, you might need to specify the path to `pg_config`. For example, on macOS with PostgreSQL installed via Homebrew:
11+
Before enabling the extension you need to initialize `pgrx`. The easiest way to get started is to allow `pgrx` to manage its own version/s of Postgres:
1212

1313
```bash
14-
cargo pgrx init --pg14 "/opt/homebrew/bin/pg_config"
14+
cargo pgrx init --pg16=download
1515
```
1616

17+
For more advanced configuration options, like building against an existing Postgres installation from e.g. Homebrew, see the [pgrx docs](https://github.com/pgcentralfoundation/pgrx)
18+
1719
To start the database:
1820

1921
```bash
20-
cargo pgrx start pg14
22+
cargo pgrx start pg16
2123
```
2224

2325
To connect:
2426

2527
```bash
26-
cargo pgrx connect pg14
28+
cargo pgrx connect pg16
2729
```
2830

29-
Finally, to enable the `pg_graphql` extension in PostgreSQL, execute the `create extension` statement. This extension creates its own schema/namespace named `graphql` to avoid naming conflicts.
31+
Finally, to enable the `pg_graphql` extension in Postgres, execute the `create extension` statement. This extension creates its own schema/namespace named `graphql` to avoid naming conflicts.
3032

3133
```psql
3234
create extension pg_graphql;
3335
```
3436

35-
These additional steps ensure that `pgrx` is properly initialized, and the database is started and connected before attempting to install and use the `pg_graphql` extension.
37+
These steps ensure that `pgrx` is properly initialized, and the database is started and connected before attempting to install and use the `pg_graphql` extension.

0 commit comments

Comments
 (0)