Skip to content

Commit db1670f

Browse files
committed
Add alpha quality note about librarization
1 parent 7d927a3 commit db1670f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,11 @@ GRANT SELECT ON postgres_exporter.pg_stat_replication TO postgres_exporter;
132132
> DATA_SOURCE_NAME=postgresql://postgres_exporter:password@localhost:5432/postgres?sslmode=disable
133133
> ```
134134
135+
# Use as a library
136+
Although the exporter is now structured to be able to be used as a library, this is highly experimental
137+
and not supported or considered stable. The interface will stabilize eventually, but at the moment is a
138+
very rough port of the CLI and should be considered _alpha_ quality.
139+
135140
# Hacking
136141
* To build a copy for your current architecture run `go run mage.go binary` or just `go run mage.go`
137142
This will create a symlink to the just built binary in the root directory.

0 commit comments

Comments
 (0)