Releasing v0.2.0

khonsulabs · Feb 18, 2022 · 0388573 · 0388573
1 parent 37778e4
commit 0388573
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -2,9 +2,9 @@
 
 ![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/workflow/status/khonsulabs/bonsaidb/Tests/release)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
-[![HTML Coverage Report for `release`](https://dev.bonsaidb.io/release/coverage/badge.svg)](https://dev.bonsaidb.io/release/coverage/)
-[![Documentation for `release`](https://img.shields.io/badge/docs-release-informational)](https://dev.bonsaidb.io/release/docs/bonsaidb)
+[![Live Build Status](https://img.shields.io/github/workflow/status/khonsulabs/bonsaidb/Tests/v0.2.0)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
+[![HTML Coverage Report for `v0.2.0`](https://dev.bonsaidb.io/v0.2.0/coverage/badge.svg)](https://dev.bonsaidb.io/v0.2.0/coverage/)
+[![Documentation for `v0.2.0`](https://img.shields.io/badge/docs-v0.2.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
@@ -18,8 +18,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/release/guide/about/concepts/collection.html
-[key-value]: https://dev.bonsaidb.io/release/guide/traits/key-value.html
+[collection]: https://dev.bonsaidb.io/v0.2.0/guide/about/concepts/collection.html
+[key-value]: https://dev.bonsaidb.io/v0.2.0/guide/traits/key-value.html
 
 ## ⚠️ Status of this project
 
@@ -90,8 +90,8 @@ 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/release/examples/basic-local/examples/view-examples.rs
-[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/release/examples/README.md
+[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/v0.2.0/examples/basic-local/examples/view-examples.rs
+[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/v0.2.0/examples/README.md
 
 ## Minimum Supported Rust Version (MSRV)
 
@@ -126,7 +126,7 @@ bonsaidb = { version = "*", default-features = false, features = "local-full" }
 ```
 
 - `local-full`: Enables all the flags below
-- `local`: Enables the [`local`](https://dev.bonsaidb.io/release/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`.
 - `local-cli`: Enables the `clap` structures for embedding database
   management commands into your own command-line interface.
@@ -145,7 +145,7 @@ bonsaidb = { version = "*", default-features = false, features = "server-full" }
 ```
 
 - `server-full`: Enables all the flags below,
-- `server`: Enables the [`server`](https://dev.bonsaidb.io/release/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`.
 - `server-acme`: Enables automtic certificate acquisition through ACME/LetsEncrypt.
 - `server-cli`: Enables the `cli` module.
@@ -166,7 +166,7 @@ bonsaidb = { version = "*", default-features = false, features = "client-full" }
 ```
 
 - `client-full`: Enables `client`, `client-trusted-dns`, `client-websockets`, and `client-password-hashing`.
-- `client`: Enables the [`client`](https://dev.bonsaidb.io/release/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`.
 - `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.

diff --git a/crates/bonsaidb-client/README.md b/crates/bonsaidb-client/README.md
@@ -9,8 +9,8 @@ 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.
 
-[`Client`](https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.Client.html) provides access to BonsaiDb by implementing the
-[`StorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html) trait.
+[`Client`](https://docs.rs/bonsaidb-client/*/bonsaidb_client/struct.Client.html) provides access to BonsaiDb by implementing the
+[`StorageConnection`](https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.StorageConnection.html) trait.
 
 ## Minimum Supported Rust Version (MSRV)
 

diff --git a/crates/bonsaidb-local/README.md b/crates/bonsaidb-local/README.md
@@ -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)
 

diff --git a/crates/bonsaidb-server/README.md b/crates/bonsaidb-server/README.md
@@ -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.
@@ -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/release/guide/integration/server.html).
+server](https://dev.bonsaidb.io/v0.2.0/guide/integration/server.html).
 
 ## Minimum Supported Rust Version (MSRV)
 

diff --git a/crates/bonsaidb-server/src/.crate-docs.md b/crates/bonsaidb-server/src/.crate-docs.md
@@ -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/release/guide/integration/server.html).
+server](https://dev.bonsaidb.io/v0.2.0/guide/integration/server.html).
 
 ## Minimum Supported Rust Version (MSRV)
 

diff --git a/crates/bonsaidb/crate-docs.md b/crates/bonsaidb/crate-docs.md
@@ -1,8 +1,8 @@
 ![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/workflow/status/khonsulabs/bonsaidb/Tests/release)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
-[![HTML Coverage Report for `release`](https://dev.bonsaidb.io/release/coverage/badge.svg)](https://dev.bonsaidb.io/release/coverage/)
-[![Documentation for `release`](https://img.shields.io/badge/docs-release-informational)](https://dev.bonsaidb.io/release/docs/bonsaidb)
+[![Live Build Status](https://img.shields.io/github/workflow/status/khonsulabs/bonsaidb/Tests/v0.2.0)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
+[![HTML Coverage Report for `v0.2.0`](https://dev.bonsaidb.io/v0.2.0/coverage/badge.svg)](https://dev.bonsaidb.io/v0.2.0/coverage/)
+[![Documentation for `v0.2.0`](https://img.shields.io/badge/docs-v0.2.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
@@ -16,8 +16,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/release/guide/about/concepts/collection.html
-[key-value]: https://dev.bonsaidb.io/release/guide/traits/key-value.html
+[collection]: https://dev.bonsaidb.io/v0.2.0/guide/about/concepts/collection.html
+[key-value]: https://dev.bonsaidb.io/v0.2.0/guide/traits/key-value.html
 
 ## ⚠️ Status of this project
 
@@ -88,8 +88,8 @@ 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/release/examples/basic-local/examples/view-examples.rs
-[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/release/examples/README.md
+[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/v0.2.0/examples/basic-local/examples/view-examples.rs
+[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/v0.2.0/examples/README.md
 
 ## Minimum Supported Rust Version (MSRV)
 
@@ -124,7 +124,7 @@ bonsaidb = { version = "*", default-features = false, features = "local-full" }
 ```
 
 - `local-full`: Enables all the flags below
-- `local`: Enables the [`local`](https://dev.bonsaidb.io/release/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`.
 - `local-cli`: Enables the `clap` structures for embedding database
   management commands into your own command-line interface.
@@ -143,7 +143,7 @@ bonsaidb = { version = "*", default-features = false, features = "server-full" }
 ```
 
 - `server-full`: Enables all the flags below,
-- `server`: Enables the [`server`](https://dev.bonsaidb.io/release/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`.
 - `server-acme`: Enables automtic certificate acquisition through ACME/LetsEncrypt.
 - `server-cli`: Enables the `cli` module.
@@ -164,7 +164,7 @@ bonsaidb = { version = "*", default-features = false, features = "client-full" }
 ```
 
 - `client-full`: Enables `client`, `client-trusted-dns`, `client-websockets`, and `client-password-hashing`.
-- `client`: Enables the [`client`](https://dev.bonsaidb.io/release/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`.
 - `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.