Skip to content

Commit f64e710

Browse files
committed
Small readme cleanups
1 parent e71c4e5 commit f64e710

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
# pgzx - Create Postgres Extensions with Zig!
1414

15-
`pgzx` is a library for developing PostgreSQL extensions written in Zig. It provides a set of utilities (e.g. error handling, memory allocators, wrappers) that simplify integrating with the Postgres code base.
15+
`pgzx` is a library for developing PostgreSQL extensions written in Zig. It provides a set of utilities (e.g. error handling, memory allocators, wrappers) as well as a development environment that simplify integrating with the Postgres code base.
1616

1717
## Why Zig?
1818

@@ -42,7 +42,7 @@ We recommend checking the examples in the section above to understand how to use
4242

4343
This project uses [Nix flakes](https://nixos.wiki/wiki/Flakes) to manage build dependencies and provide a development shell. We provide a template for you initialize a new Zig based Postgres extension project, which allows you to reuse some of the utilities we're using.
4444

45-
Before getting started we would recommend you to familiarize yourself with the projects setup first. To do so, please start with the [Contributing][#contributing] section.
45+
Before getting started we would recommend you to familiarize yourself with the projects setup first. To do so, please start with the [Contributing](#contributing) section.
4646

4747
We will create a new project folder for our new extension and initialize the folder using the projects template:
4848

@@ -52,7 +52,7 @@ $ cd my_extension
5252
$ nix flake init -t github:xataio/pgzx
5353
```
5454

55-
This step will create a working extension named 'my_extension'. The extension exports a hello world function named 'hello()'.
55+
This step will create a working extension named 'my_extension'. The extension exports a hello world function named `hello()`.
5656

5757
The templates [README.md](./nix/templates/init/README.md) file already contains instructions on how to enter the development shell, build, and test the extension. You can follow the instructions and verify that your setup is functioning. Do not forget to use `pgstop` before quitting the development shell.
5858

0 commit comments

Comments
 (0)