Update documentation and version to 1.0.2 (#126)

aws · May 12, 2023 · 5d99494 · 5d99494
1 parent 55df26a
commit 5d99494
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 14 deletions.
diff --git a/aws-lc-rs/Cargo.toml b/aws-lc-rs/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "aws-lc-rs"
 authors = ["AWS-LibCrypto"]
-version = "1.0.1"
+version = "1.0.2"
 edition = "2021"
 rust-version = "1.60"
 keywords = ["crypto", "cryptography", "security"]
@@ -30,7 +30,7 @@ fips = ["dep:aws-lc-fips-sys"]
 
 [dependencies]
 untrusted = { version = "0.7.1", optional = true }
-aws-lc-sys = { version = "0.6.0", path = "../aws-lc-sys", optional = true }
+aws-lc-sys = { version = "0.6.1", path = "../aws-lc-sys", optional = true }
 aws-lc-fips-sys = { version = "0.7.1", path = "../aws-lc-fips-sys", optional = true }
 zeroize = "1"
 mirai-annotations = "1.12.0"

diff --git a/aws-lc-rs/README.md b/aws-lc-rs/README.md
@@ -20,15 +20,16 @@ aws-lc-rs = "1.0.0"
 Consuming projects will need a C Compiler (Clang or GCC) and Cmake to build.
 
 **Requirements**:
-* C compiler (Clang or GCC)
-* Cmake (> v3.12)
-* Linux or [macOS](https://www.apple.com/macos)
+* C compiler (Clang or GCC or Visual Studio Build Tools 2017)
+* Cmake (>= v3.12)
+* Linux or [macOS](https://www.apple.com/macos) or Windows
 
-**Feature-specific Requirements**
+**Platform- and Feature-specific Requirements**
   * Linux - required for `fips`
   * [Go](https://go.dev/) - required for `fips`
-  * [libclang](https://llvm.org/) - required for `bindgen`
-    * see [Rust-bindgen requirements](https://rust-lang.github.io/rust-bindgen/requirements.html) for more information.
+  * [libclang](https://llvm.org/) - required for `bindgen` and for any platform lacking pre-generated bindings (like Windows or M1 Macs)
+
+See our [User Guide](https://awslabs.github.io/aws-lc-rs/) for guidance on installing these requirements.
 
 ### Contributor Quickstart for Amazon Linux 2023
 

diff --git a/aws-lc-rs/src/lib.rs b/aws-lc-rs/src/lib.rs
@@ -20,15 +20,16 @@
 //! Consuming projects will need a C Compiler (Clang or GCC) and Cmake to build.
 //!
 //! **Requirements**:
-//! * C compiler (Clang or GCC)
-//! * Cmake (> v3.12)
-//! * Linux or [macOS](https://www.apple.com/macos)
+//! * C compiler (Clang or GCC or Visual Studio Build Tools 2017)
+//! * Cmake (>= v3.12)
+//! * Linux or [macOS](https://www.apple.com/macos) or Windows
 //!
-//! **Feature-specific Requirements**
+//! **Platform- and Feature-specific Requirements**
 //!   * Linux - required for `fips`
 //!   * [Go](https://go.dev/) - required for `fips`
-//!   * [libclang](https://llvm.org/) - required for `bindgen`
-//!     * see [Rust-bindgen requirements](https://rust-lang.github.io/rust-bindgen/requirements.html) for more information.
+//!   * [libclang](https://llvm.org/) - required for `bindgen` and for any platform lacking pre-generated bindings (like Windows or M1 Macs)
+//!
+//! See our [User Guide](https://awslabs.github.io/aws-lc-rs/) for guidance on installing these requirements.
 //!
 //! ## Contributor Quickstart for Amazon Linux 2023
 //!