Skip to content

Commit

Permalink
Recreating release branch from main
Browse files Browse the repository at this point in the history
  • Loading branch information
ecton committed Oct 5, 2023
1 parent 0992510 commit 0081106
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 32 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
![BonsaiDb forbids unsafe code](https://img.shields.io/badge/unsafe-forbid-success)
![BonsaiDb is considered alpha](https://img.shields.io/badge/status-alpha-orange)
[![crate version](https://img.shields.io/crates/v/bonsaidb.svg)](https://crates.io/crates/bonsaidb)
[![Live Build Status](https://img.shields.io/github/actions/workflow/status/khonsulabs/bonsaidb/tests.yml?branch=main)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
[![HTML Coverage Report for `main`](https://dev.bonsaidb.io/main/coverage/badge.svg)](https://dev.bonsaidb.io/main/coverage/)
[![Documentation for `main`](https://img.shields.io/badge/docs-main-informational)](https://dev.bonsaidb.io/main/docs/bonsaidb)
[![Live Build Status](https://img.shields.io/github/actions/workflow/status/khonsulabs/bonsaidb/tests.yml?branch=v0.5.0)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
[![HTML Coverage Report for `v0.5.0`](https://dev.bonsaidb.io/v0.5.0/coverage/badge.svg)](https://dev.bonsaidb.io/v0.5.0/coverage/)
[![Documentation for `v0.5.0`](https://img.shields.io/badge/docs-v0.5.0-informational)](https://docs.rs/bonsaidb)

BonsaiDb is a developer-friendly document database for
[Rust](https://rust-lang.org) that grows with you. It offers many features out
Expand All @@ -19,8 +19,8 @@ of the box that many developers need:
- Local-only access, networked access via QUIC, or networked access via WebSockets
- And [much more](https://bonsaidb.io/about).

[collection]: https://dev.bonsaidb.io/main/guide/about/concepts/collection.html
[key-value]: https://dev.bonsaidb.io/main/guide/traits/key-value.html
[collection]: https://dev.bonsaidb.io/v0.5.0/guide/about/concepts/collection.html
[key-value]: https://dev.bonsaidb.io/v0.5.0/guide/traits/key-value.html

## ⚠️ Status of this project

Expand Down Expand Up @@ -94,12 +94,12 @@ println!("Number of triangles: {}", triangles.len());

You can review the [full example in the repository][view-examples], or see all available examples [in the examples README][examples-readme].

[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/main/examples/basic-local/examples/view-examples.rs
[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/main/examples/README.md
[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/v0.5.0/examples/basic-local/examples/view-examples.rs
[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/v0.5.0/examples/README.md

## User's Guide

Our user's guide is early in development, but is available at: <https://dev.bonsaidb.io/main/guide/>
Our user's guide is early in development, but is available at: <https://dev.bonsaidb.io/v0.5.0/guide/>

## Minimum Supported Rust Version (MSRV)

Expand Down Expand Up @@ -139,7 +139,7 @@ bonsaidb = { version = "*", features = "local-full" }
All Cargo features that affect local databases:

- `local-full`: Enables all the flags below
- `local`: Enables the [`local`](https://dev.bonsaidb.io/main/docs/bonsaidb/local/) module, which re-exports the crate
- `local`: Enables the [`local`](https://docs.rs/bonsaidb/local/) module, which re-exports the crate
`bonsaidb-local`.
- `async`: Enables async support with Tokio.
- `cli`: Enables the `clap` structures for embedding database
Expand All @@ -162,7 +162,7 @@ bonsaidb = { version = "*", features = "server-full" }
All Cargo features that affect networked servers:

- `server-full`: Enables all the flags below,
- `server`: Enables the [`server`](https://dev.bonsaidb.io/main/docs/bonsaidb/server/) module, which re-exports the crate
- `server`: Enables the [`server`](https://docs.rs/bonsaidb/server/) module, which re-exports the crate
`bonsaidb-server`.
- `acme`: Enables automtic certificate acquisition through ACME/LetsEncrypt.
- `cli`: Enables the `cli` module.
Expand All @@ -187,7 +187,7 @@ bonsaidb = { version = "*", features = "client-full" }
All Cargo features that affect networked clients:

- `client-full`: Enables all flags below.
- `client`: Enables the [`client`](https://dev.bonsaidb.io/main/docs/bonsaidb/client/) module, which re-exports the crate
- `client`: Enables the [`client`](https://docs.rs/bonsaidb/client/) module, which re-exports the crate
`bonsaidb-client`.
- `trusted-dns`: Enables using trust-dns for DNS resolution. If not
enabled, all DNS resolution is done with the OS's default name resolver.
Expand Down
8 changes: 4 additions & 4 deletions crates/bonsaidb-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ QUIC is a new protocol built atop UDP. It is designed to operate more
reliably than TCP, and features TLS built-in at the protocol level.
WebSockets are an established protocol built atop TCP and HTTP.

[`BlockingClient`](https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.BlockingClient.html) provides access to BonsaiDb by implementing
the [`StorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html) trait.
[`AsyncClient`](https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.AsyncClient.html) provides access to BonsaiDb by implementing
the [`AsyncStorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.AsyncStorageConnection.html) trait.
[`BlockingClient`](https://docs.rs/bonsaidb-client/*/bonsaidb_client/struct.BlockingClient.html) provides access to BonsaiDb by implementing
the [`StorageConnection`](https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.StorageConnection.html) trait.
[`AsyncClient`](https://docs.rs/bonsaidb-client/*/bonsaidb_client/struct.AsyncClient.html) provides access to BonsaiDb by implementing
the [`AsyncStorageConnection`](https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.AsyncStorageConnection.html) trait.

## Minimum Supported Rust Version (MSRV)

Expand Down
4 changes: 2 additions & 2 deletions crates/bonsaidb-local/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
BonsaiDb's offline database implementation.

This crate exposes BonsaiDb's local database implementation. The
[`Storage`](https://dev.bonsaidb.io/main/docs/bonsaidb_local/struct.Storage.html) type provides its most common functionality by
implementing the [`StorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html).
[`Storage`](https://docs.rs/bonsaidb-client/*/bonsaidb_local/struct.Storage.html) type provides its most common functionality by
implementing the [`StorageConnection`](https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.StorageConnection.html).

## Minimum Supported Rust Version (MSRV)

Expand Down
6 changes: 3 additions & 3 deletions crates/bonsaidb-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
BonsaiDb's networked database implementation.

This crate implements BonsaiDb's networked database implementation. The
[`Server`](https://dev.bonsaidb.io/main/docs/bonsaidb_server/type.Server.html) and [`CustomServer<Backend>`](https://dev.bonsaidb.io/main/docs/bonsaidb_server/struct.CustomServer.html)
[`Server`](https://docs.rs/bonsaidb-server/*/bonsaidb_server/type.Server.html) and [`CustomServer<Backend>`](https://docs.rs/bonsaidb-server/*/bonsaidb_server/struct.CustomServer.html)
types provide their most common functionality by implementing the
[`StorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html).
[`StorageConnection`](https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.StorageConnection.html).

This crate supports two methods for exposing a BonsaiDb server: QUIC and
WebSockets.
Expand All @@ -15,7 +15,7 @@ reliably than TCP, and features TLS built-in at the protocol level.
WebSockets are an established protocol built atop TCP and HTTP.

Our user's guide has a section covering [setting up and accessing a BonsaiDb
server](https://dev.bonsaidb.io/main/guide/integration/server.html).
server](https://dev.bonsaidb.io/v0.5.0/guide/integration/server.html).

## Minimum Supported Rust Version (MSRV)

Expand Down
2 changes: 1 addition & 1 deletion crates/bonsaidb-server/src/.crate-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ reliably than TCP, and features TLS built-in at the protocol level.
WebSockets are an established protocol built atop TCP and HTTP.

Our user's guide has a section covering [setting up and accessing a BonsaiDb
server](https://dev.bonsaidb.io/main/guide/integration/server.html).
server](https://dev.bonsaidb.io/v0.5.0/guide/integration/server.html).

## Minimum Supported Rust Version (MSRV)

Expand Down
22 changes: 11 additions & 11 deletions crates/bonsaidb/crate-docs.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
![BonsaiDb forbids unsafe code](https://img.shields.io/badge/unsafe-forbid-success)
![BonsaiDb is considered alpha](https://img.shields.io/badge/status-alpha-orange)
[![crate version](https://img.shields.io/crates/v/bonsaidb.svg)](https://crates.io/crates/bonsaidb)
[![Live Build Status](https://img.shields.io/github/actions/workflow/status/khonsulabs/bonsaidb/tests.yml?branch=main)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
[![HTML Coverage Report for `main`](https://dev.bonsaidb.io/main/coverage/badge.svg)](https://dev.bonsaidb.io/main/coverage/)
[![Documentation for `main`](https://img.shields.io/badge/docs-main-informational)](https://dev.bonsaidb.io/main/docs/bonsaidb)
[![Live Build Status](https://img.shields.io/github/actions/workflow/status/khonsulabs/bonsaidb/tests.yml?branch=v0.5.0)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
[![HTML Coverage Report for `v0.5.0`](https://dev.bonsaidb.io/v0.5.0/coverage/badge.svg)](https://dev.bonsaidb.io/v0.5.0/coverage/)
[![Documentation for `v0.5.0`](https://img.shields.io/badge/docs-v0.5.0-informational)](https://docs.rs/bonsaidb)

BonsaiDb is a developer-friendly document database for
[Rust](https://rust-lang.org) that grows with you. It offers many features out
Expand All @@ -17,8 +17,8 @@ of the box that many developers need:
- Local-only access, networked access via QUIC, or networked access via WebSockets
- And [much more](https://bonsaidb.io/about).

[collection]: https://dev.bonsaidb.io/main/guide/about/concepts/collection.html
[key-value]: https://dev.bonsaidb.io/main/guide/traits/key-value.html
[collection]: https://dev.bonsaidb.io/v0.5.0/guide/about/concepts/collection.html
[key-value]: https://dev.bonsaidb.io/v0.5.0/guide/traits/key-value.html

## ⚠️ Status of this project

Expand Down Expand Up @@ -92,12 +92,12 @@ println!("Number of triangles: {}", triangles.len());

You can review the [full example in the repository][view-examples], or see all available examples [in the examples README][examples-readme].

[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/main/examples/basic-local/examples/view-examples.rs
[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/main/examples/README.md
[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/v0.5.0/examples/basic-local/examples/view-examples.rs
[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/v0.5.0/examples/README.md

## User's Guide

Our user's guide is early in development, but is available at: <https://dev.bonsaidb.io/main/guide/>
Our user's guide is early in development, but is available at: <https://dev.bonsaidb.io/v0.5.0/guide/>

## Minimum Supported Rust Version (MSRV)

Expand Down Expand Up @@ -137,7 +137,7 @@ bonsaidb = { version = "*", features = "local-full" }
All Cargo features that affect local databases:

- `local-full`: Enables all the flags below
- `local`: Enables the [`local`](https://dev.bonsaidb.io/main/docs/bonsaidb/local/) module, which re-exports the crate
- `local`: Enables the [`local`](https://docs.rs/bonsaidb/local/) module, which re-exports the crate
`bonsaidb-local`.
- `async`: Enables async support with Tokio.
- `cli`: Enables the `clap` structures for embedding database
Expand All @@ -160,7 +160,7 @@ bonsaidb = { version = "*", features = "server-full" }
All Cargo features that affect networked servers:

- `server-full`: Enables all the flags below,
- `server`: Enables the [`server`](https://dev.bonsaidb.io/main/docs/bonsaidb/server/) module, which re-exports the crate
- `server`: Enables the [`server`](https://docs.rs/bonsaidb/server/) module, which re-exports the crate
`bonsaidb-server`.
- `acme`: Enables automtic certificate acquisition through ACME/LetsEncrypt.
- `cli`: Enables the `cli` module.
Expand All @@ -185,7 +185,7 @@ bonsaidb = { version = "*", features = "client-full" }
All Cargo features that affect networked clients:

- `client-full`: Enables all flags below.
- `client`: Enables the [`client`](https://dev.bonsaidb.io/main/docs/bonsaidb/client/) module, which re-exports the crate
- `client`: Enables the [`client`](https://docs.rs/bonsaidb/client/) module, which re-exports the crate
`bonsaidb-client`.
- `trusted-dns`: Enables using trust-dns for DNS resolution. If not
enabled, all DNS resolution is done with the OS's default name resolver.
Expand Down

0 comments on commit 0081106

Please sign in to comment.