Skip to content

Commit

Permalink
crypto: update README, docs
Browse files Browse the repository at this point in the history
Signed-off-by: Eric Lagergren <[email protected]>
  • Loading branch information
elagergren-spideroak committed Jan 24, 2025
1 parent 739a245 commit 712eb17
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
# crypto
SpiderOak's Cryptography Libraries

## Security

See our [security policy](https://github.com/aranya-project/crypto/security/policy).
4 changes: 3 additions & 1 deletion crates/crypto/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
[package]
name = "spideroak-crypto"
description = "SpiderOak's cryptography library"
version = "0.2.0"
version = "0.2.1"
authors.workspace = true
edition.workspace = true
license = "BSD-3-Clause"
readme = "README.md"
repository.workspace = true
documentation = "https://docs.rs/spideroak-crypto"
rust-version.workspace = true
categories = ["cryptography", "no-std", "no-std::no-alloc"]
keywords = ["crypto", "cryptography", "spideroak"]
Expand Down
34 changes: 34 additions & 0 deletions crates/crypto/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# `spideroak-crypto`

[![Docs][docs-img]][docs-link]

SpiderOak's cryptography library.

## Usage

This is a low-level cryptography library and can very easily be
misued. See usage-specific guidance below.

### Aranya Users

Unless you are implementing an `Engine`, you should use
[`aranya-crypto`] instead.

### SpiderOak Employees

Most projects have their own high-level cryptography APIs. Use
those instead.

## Security

See our [security policy].

[Aranya Core]: https://github.com/aranya-project/aranya
[Aranya]: https://github.com/aranya-project/aranya
[`aranya-crypto`]: https://crates.io/crates/aranya-crypto
[security policy]: https://github.com/aranya-project/aranya

[//]: # (badges)

[docs-img]: https://docs.rs/spideroak-crypto/badge.svg
[docs-link]: https://docs.rs/spideroak-crypto

0 comments on commit 712eb17

Please sign in to comment.