From 3116ca742b1ee3d5ae452bc62dc3aa7d066869e5 Mon Sep 17 00:00:00 2001 From: Hinton Date: Thu, 26 Sep 2024 14:08:12 +0200 Subject: [PATCH] Add links to documentation --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 497af6547..d739e211b 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,19 @@ To build, you will need the following in your PATH: - We recommend installing this via the [Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) +## Documentation + +Please refer to our Contributing Docs for +[getting started](https://contributing.bitwarden.com/getting-started/sdk/) instructions and +[architectural documentation](https://contributing.bitwarden.com/architecture/sdk/). + +You can also browse the latest published documentation: + +- [docs.rs](https://docs.rs/bitwarden/0.5.0/bitwarden/) for the public SDK. +- Or for developers of the SDK, view the internal + [API documentation](https://sdk-api-docs.bitwarden.com/bitwarden/index.html) which includes + private items. + ## Crates The project is structured as a monorepo using cargo workspaces. Some of the more noteworthy crates