From 5aefc84f4069ac780bb60b54ed6c928c120c101d Mon Sep 17 00:00:00 2001
From: Aydin Mercan <aydin@mercan.dev>
Date: Sat, 3 Sep 2022 17:49:57 +0300
Subject: [PATCH] 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.
---
 README.md              | 15 +++++++++++++++
 bearssl-sys/Cargo.toml |  3 ++-
 bearssl/Cargo.toml     |  5 +++--
 3 files changed, 20 insertions(+), 3 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a5e3cc1
--- /dev/null
+++ b/README.md
@@ -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.
diff --git a/bearssl-sys/Cargo.toml b/bearssl-sys/Cargo.toml
index c861ef8..e961103 100644
--- a/bearssl-sys/Cargo.toml
+++ b/bearssl-sys/Cargo.toml
@@ -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"
 
diff --git a/bearssl/Cargo.toml b/bearssl/Cargo.toml
index dfe302b..0e02ab1 100644
--- a/bearssl/Cargo.toml
+++ b/bearssl/Cargo.toml
@@ -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"