Skip to content

Commit

Permalink
Releasing 0.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ecton committed Feb 12, 2022
1 parent fe11c9a commit 75a50b2
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 28 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.1.2)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
[![HTML Coverage Report for `v0.1.2`](https://dev.bonsaidb.io/v0.1.2/coverage/badge.svg)](https://dev.bonsaidb.io/v0.1.2/coverage/)
[![Documentation for `v0.1.2`](https://img.shields.io/badge/docs-v0.1.2-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 @@ -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.1.2/guide/about/concepts/collection.html
[key-value]: https://dev.bonsaidb.io/v0.1.2/guide/traits/key-value.html

## ⚠️ Status of this project

Expand Down Expand Up @@ -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.1.2/examples/basic-local/examples/view-examples.rs
[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/v0.1.2/examples/README.md

## Feature Flags

Expand All @@ -116,7 +116,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.
Expand All @@ -134,7 +134,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.
Expand All @@ -154,7 +154,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.
Expand Down
4 changes: 2 additions & 2 deletions crates/bonsaidb-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## WASM Support

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).

## Feature Flags

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/release/guide/integration/server.html).
server](https://dev.bonsaidb.io/v0.1.2/guide/integration/server.html).

## Feature Flags

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,4 +13,4 @@ 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.1.2/guide/integration/server.html).
20 changes: 10 additions & 10 deletions crates/bonsaidb/crate-docs.md
Original file line number Diff line number Diff line change
@@ -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.1.2)](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
[![HTML Coverage Report for `v0.1.2`](https://dev.bonsaidb.io/v0.1.2/coverage/badge.svg)](https://dev.bonsaidb.io/v0.1.2/coverage/)
[![Documentation for `v0.1.2`](https://img.shields.io/badge/docs-v0.1.2-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 @@ -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.1.2/guide/about/concepts/collection.html
[key-value]: https://dev.bonsaidb.io/v0.1.2/guide/traits/key-value.html

## ⚠️ Status of this project

Expand Down Expand Up @@ -86,8 +86,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.1.2/examples/basic-local/examples/view-examples.rs
[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/v0.1.2/examples/README.md

## Feature Flags

Expand All @@ -114,7 +114,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.
Expand All @@ -132,7 +132,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.
Expand All @@ -152,7 +152,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.
Expand Down

0 comments on commit 75a50b2

Please sign in to comment.