Skip to content

Commit 98e20cd

Browse files
authored
docs(pgdog-plugin): update the README and lib docs (#772)
Little update of the docs based on latest changes from #770
1 parent f4a6772 commit 98e20cd

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

pgdog-plugin/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# PgDog plugins
22

3-
[![Documentation](https://img.shields.io/badge/documentation-blue?style=flat)](https://docsrs.pgdog.dev/pgdog_plugin/index.html)
3+
[![Tutorial](https://img.shields.io/badge/Tutorial-blue)](https://docs.pgdog.dev/features/plugins/)
4+
[![docs.rs](https://img.shields.io/docsrs/pgdog-plugin)](https://docsrs.pgdog.dev/pgdog_plugin/index.html)
45
[![Latest crate](https://img.shields.io/crates/v/pgdog-plugin.svg)](https://crates.io/crates/pgdog-plugin)
56

67
PgDog plugin system is based around shared libraries loaded at runtime. The plugins currently can only be
@@ -12,13 +13,13 @@ This crate implements the bridge between PgDog and plugins, making sure data typ
1213
Automatic checks include:
1314

1415
- Rust compiler version check
15-
- `pg_query` version check
16+
- `pgdog-plugin` crate version check
1617

1718
This crate should be linked at compile time against your plugins.
1819

1920
## Writing plugins
2021

21-
See [documentation](https://docsrs.pgdog.dev/pgdog_plugin/index.html) for examples. Example plugins are [available in GitHub](https://github.com/pgdogdev/pgdog/tree/main/plugins) as well.
22+
See [crate documentation](https://docsrs.pgdog.dev/pgdog_plugin/index.html) and [pgdog tutorial](https://docs.pgdog.dev/features/plugins/) for guides and examples. Example plugins are [available in GitHub](https://github.com/pgdogdev/pgdog/tree/main/plugins) as well.
2223

2324
## License
2425

pgdog-plugin/src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
//!
1515
//! ```toml
1616
//! [lib]
17-
//! crate-type = ["rlib", "cdylib"]
17+
//! crate-type = ["cdylib"]
1818
//! ```
1919
//!
2020
//! ## Dependencies
@@ -26,7 +26,7 @@
2626
//! following 2 requirements:
2727
//!
2828
//! 1. Plugins must be compiled with the **same version of the Rust compiler** as PgDog. This is automatically checked at runtime and plugins that don't do this are not loaded.
29-
//! 2. Plugins must use the **same version of [`pg_query`] crate** as PgDog. This happens automatically when using `pg_query` structs re-exported by this crate.
29+
//! 2. Plugins must use the **same version of `pgdog-plugin` crate** as PgDog. This is automatically checked at runtime and plugins that use incompatible versions are not loaded.
3030
//!
3131
//!
3232
//! #### Configure dependencies
@@ -35,7 +35,7 @@
3535
//!
3636
//! ```toml
3737
//! [dependencies]
38-
//! pgdog-plugin = "0.1.6"
38+
//! pgdog-plugin = "0.2.0"
3939
//! ```
4040
//!
4141
//! # Required methods

0 commit comments

Comments
 (0)