Skip to content

Commit

Permalink
docs: add quickstart section for installation
Browse files Browse the repository at this point in the history
  • Loading branch information
fboulnois committed Jan 2, 2023
1 parent 2d62733 commit a37bb9b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ include 74 random bits which means [billions can be created every second](https:
without collisions. Because of their structure they are globally sortable and
can be created in parallel in a distributed system.

## Quickstart

1. Download the [latest `.tar.gz` release](https://github.com/fboulnois/pg_uuidv7/releases)
and extract it to a temporary directory
2. Copy `pg_uuidv7.so` into the Postgres module directory
3. Copy `pg_uuidv7.control` and `pg_uuidv7--1.0.sql` into the Postgres extension
directory
4. Add `pg_uuidv7` to the `shared_preload_libraries` setting in `postgresql.conf`
5. Enable the extension in the database using `CREATE EXTENSION pg_uuidv7;`

## Build

### Build locally
Expand Down

0 comments on commit a37bb9b

Please sign in to comment.