Skip to content

Commit 7770b65

Browse files
brianheinemanbrianheineman
committed
docs: update documentation
1 parent b229dbf commit 7770b65

File tree

4 files changed

+22
-71
lines changed

4 files changed

+22
-71
lines changed

‎postgresql_archive/README.md‎

Lines changed: 15 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,37 @@
88
[![License](https://img.shields.io/crates/l/postgresql_archive?)](https://github.com/theseus-rs/postgresql-embedded/tree/main/postgresql_archive#license)
99
[![Semantic Versioning](https://img.shields.io/badge/%E2%9A%99%EF%B8%8F_SemVer-2.0.0-blue)](https://semver.org/spec/v2.0.0.html)
1010

11-
A library for downloading and extracting PostgreSQL archives.
11+
A configurable library for downloading and extracting PostgreSQL archives.
1212

1313
## Examples
1414

1515
### Asynchronous API
1616

1717
```rust
18-
use postgresql_archive::{extract, get_archive, Result, LATEST};
18+
use postgresql_archive::{extract, get_archive, Result, VersionReq};
19+
use postgresql_archive::configuration::theseus;
1920

2021
#[tokio::main]
2122
async fn main() -> Result<()> {
22-
let (archive_version, archive) = get_archive(&LATEST).await?;
23+
let url = theseus::URL;
24+
let (archive_version, archive) = get_archive(url, &VersionReq::STAR).await?;
2325
let out_dir = std::env::temp_dir();
24-
extract(&archive, &out_dir).await
26+
extract(url, &archive, &out_dir).await
2527
}
2628
```
2729

2830
### Synchronous API
2931

3032
```rust
31-
use postgresql_archive::{Result, LATEST};
33+
use postgresql_archive::configuration::theseus;
34+
use postgresql_archive::{Result, VersionReq};
3235
use postgresql_archive::blocking::{extract, get_archive};
3336

3437
fn main() -> Result<()> {
35-
let (archive_version, archive) = get_archive(&LATEST)?;
38+
let url = theseus::URL;
39+
let (archive_version, archive) = get_archive(url, &VersionReq::STAR)?;
3640
let out_dir = std::env::temp_dir();
37-
extract(&archive, &out_dir)
41+
extract(url, &archive, &out_dir)
3842
}
3943
```
4044

@@ -53,36 +57,10 @@ The following features are available:
5357

5458
## Supported platforms
5559

56-
`postgresql_archive` supports all platforms provided
57-
by [theseus-rs/postgresql-binaries](https://github.com/theseus-rs/postgresql-binaries).
58-
59-
Currently supported platforms are:
60-
61-
| OS | [Target](https://doc.rust-lang.org/nightly/rustc/platform-support.html) |
62-
|---------|-------------------------------------------------------------------------|
63-
| Linux | aarch64-unknown-linux-gnu |
64-
| Linux | aarch64-unknown-linux-musl |
65-
| Linux | arm-unknown-linux-gnueabi |
66-
| Linux | arm-unknown-linux-gnueabihf |
67-
| Linux | arm-unknown-linux-musleabi |
68-
| Linux | arm-unknown-linux-musleabihf |
69-
| Linux | armv5te-unknown-linux-gnueabi |
70-
| Linux | armv7-unknown-linux-gnueabihf |
71-
| Linux | armv7-unknown-linux-musleabihf |
72-
| Linux | i586-unknown-linux-gnu |
73-
| Linux | i586-unknown-linux-musl |
74-
| Linux | i686-unknown-linux-gnu |
75-
| Linux | i686-unknown-linux-musl |
76-
| Linux | mips64-unknown-linux-gnuabi64 |
77-
| Linux | powerpc64le-unknown-linux-gnu |
78-
| Linux | powerpc64le-unknown-linux-musl |
79-
| Linux | s390x-unknown-linux-gnu |
80-
| Linux | s390x-unknown-linux-musl |
81-
| Linux | x86_64-unknown-linux-gnu |
82-
| Linux | x86_64-unknown-linux-musl |
83-
| MacOS | aarch64-apple-darwin |
84-
| MacOS | x86_64-apple-darwin |
85-
| Windows | x86_64-pc-windows-msvc |
60+
`postgresql_archive` provides implementations for the following:
61+
62+
* [theseus-rs/postgresql-binaries](https://github.com/theseus-rs/postgresql-binaries)
63+
* [zonkyio/embedded-postgres-binaries](https://github.com/zonkyio/embedded-postgres-binaries)
8664

8765
## Safety
8866

‎postgresql_archive/src/configuration/zonky/repository.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ use tracing::instrument;
99

1010
/// Zonky repository.
1111
///
12-
/// This repository is used to interact with Maven repositories
13-
/// (e.g. <https://repo1.maven.org/maven2>).
12+
/// This repository is used to interact with Zonky Maven repositories
13+
/// (e.g. <https://repo1.maven.org/maven2/io/zonky/test/postgres">).
1414
#[derive(Debug)]
1515
pub struct Zonky {
1616
maven: Box<dyn Repository>,

‎postgresql_archive/src/lib.rs‎

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
//!
2727
//! #[tokio::main]
2828
//! async fn main() -> Result<()> {
29-
//! let url = theseus::URL;
29+
//! let url = theseus::URL;
3030
//! let (archive_version, archive) = get_archive(url, &VersionReq::STAR).await?;
3131
//! let out_dir = std::env::temp_dir();
3232
//! extract(url, &archive, &out_dir).await
@@ -62,33 +62,10 @@
6262
//!
6363
//! ## Supported platforms
6464
//!
65-
//! postgresql_archive supports all platforms provided by [theseus-rs/postgresql-binaries](https://github.com/theseus-rs/postgresql-binaries):
66-
//!
67-
//! | OS | [Target](https://doc.rust-lang.org/nightly/rustc/platform-support.html) |
68-
//! |---------|-------------------------------------------------------------------------|
69-
//! | Linux | aarch64-unknown-linux-gnu |
70-
//! | Linux | aarch64-unknown-linux-musl |
71-
//! | Linux | arm-unknown-linux-gnueabi |
72-
//! | Linux | arm-unknown-linux-gnueabihf |
73-
//! | Linux | arm-unknown-linux-musleabi |
74-
//! | Linux | arm-unknown-linux-musleabihf |
75-
//! | Linux | armv5te-unknown-linux-gnueabi |
76-
//! | Linux | armv7-unknown-linux-gnueabihf |
77-
//! | Linux | armv7-unknown-linux-musleabihf |
78-
//! | Linux | i586-unknown-linux-gnu |
79-
//! | Linux | i586-unknown-linux-musl |
80-
//! | Linux | i686-unknown-linux-gnu |
81-
//! | Linux | i686-unknown-linux-musl |
82-
//! | Linux | mips64-unknown-linux-gnuabi64 |
83-
//! | Linux | powerpc64le-unknown-linux-gnu |
84-
//! | Linux | powerpc64le-unknown-linux-musl |
85-
//! | Linux | s390x-unknown-linux-gnu |
86-
//! | Linux | s390x-unknown-linux-musl |
87-
//! | Linux | x86_64-unknown-linux-gnu |
88-
//! | Linux | x86_64-unknown-linux-musl |
89-
//! | MacOS | aarch64-apple-darwin |
90-
//! | MacOS | x86_64-apple-darwin |
91-
//! | Windows | x86_64-pc-windows-msvc |
65+
//! `postgresql_archive` provides implementations for the following:
66+
//!
67+
//! * [theseus-rs/postgresql-binaries](https://github.com/theseus-rs/postgresql-binaries)
68+
//! * [zonkyio/embedded-postgres-binaries](https://github.com/zonkyio/embedded-postgres-binaries)
9269
//!
9370
//! ## Safety
9471
//!

‎postgresql_embedded/src/lib.rs‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,6 @@
103103
//! at your option.
104104
//!
105105
//! PostgreSQL is covered under [The PostgreSQL License](https://opensource.org/licenses/postgresql).
106-
//!
107-
//! ## Notes
108-
//!
109-
//! Uses PostgreSQL binaries from [theseus-rs/postgresql-binaries](https://github.com/theseus-rs/postgresql-binaries).
110106
111107
#![forbid(unsafe_code)]
112108
#![deny(clippy::pedantic)]

0 commit comments

Comments
 (0)