readme, cargo: document and categorize more

* Reduce the version of `bearssl` to 0.0.2 to increment minimally from
  the existing crate.
* Add an overview README for a high level description.
* Add crate tags and categories for easier discoverability in the
  future.
main
Aydin Mercan 2022-09-03 17:49:57 +03:00
parent eca97f9f0b
commit 5aefc84f40
Signed by: jaiden
SSH Key Fingerprint: SHA256:vy6hjzotbn/MWZAbjzURNk3NL62EPkjoHsJ5xr/s7nk
3 changed files with 20 additions and 3 deletions

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# BearSSL-rs
Use and extend BearSSL in Rust.
## Crates
* `bearssl-sys`: Autogenerated FFI bindings for BearSSL 0.6. Can use the link dynamically or bundle a build itself.
* Versions below `0.0.5` are unrelated to this crate.
* `bearssl`: Higher level code for easier use in servers, clients, etc.
* Versions below `0.0.2` are unrelated to this crate.
## License
All crates in this repository are available under `BSD-3-Clause`.
Please refer to each crate's README for more details.

View File

@ -5,7 +5,8 @@ version = "0.0.5-pre.0"
authors = ["Aydin Mercan <aydin@mercan.dev>"]
license = "BSD-3-Clause"
readme = "README.md"
keywords = ["bearssl", "tls"]
categories = ["cryptography", "no-std", "external-ffi-bindings"]
keywords = ["bearssl", "crypto", "tls", "ssl"]
edition = "2021"
rust-version = "1.63"

View File

@ -1,11 +1,12 @@
[package]
name = "bearssl"
description = "BearSSL wrapper and engine development library"
version = "0.1.0-pre.0"
version = "0.0.2-pre.0"
authors = ["Aydin Mercan <aydin@mercan.dev>"]
license = "BSD-3-Clause"
readme = "README.md"
keywords = ["bearssl", "tls"]
categories = ["cryptography", "no-std", "api-bindings"]
keywords = ["bearssl", "crypto", "tls", "ssl"]
edition = "2021"
rust-version = "1.63"