From 15284b0146d1ebe06b5ca7a6a47e3970aab60575 Mon Sep 17 00:00:00 2001 From: Maxim Ivanov Date: Sat, 11 Apr 2020 17:25:42 +0100 Subject: [PATCH] Add explicit reference to API docs helps CTRL+F Fixes: #669 --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index d96eaafd8..f8e7a0428 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,10 @@ go-pg is a PostgreSQL client and ORM. It includes many features that traditional pgx is "closer to the metal" and such abstractions are beyond the scope of the pgx project, which first and foremost, aims to be a performant driver and toolkit. +## API documentation + +Full go doc style documentation for the package can be viewed online without installing this package by using the GoDev site here: https://pkg.go.dev/github.com/jackc/pgx/v4 + ## Testing pgx tests naturally require a PostgreSQL database. It will connect to the database specified in the `PGX_TEST_DATABASE` environment