diff --git a/.github/workflows/rustls-rustcrypto.yml b/.github/workflows/rustls-rustcrypto.yml index d715294..e76faf0 100644 --- a/.github/workflows/rustls-rustcrypto.yml +++ b/.github/workflows/rustls-rustcrypto.yml @@ -21,6 +21,7 @@ jobs: strategy: matrix: toolchain: + - 1.75.0 # MSRV - stable runs-on: ubuntu-latest steps: @@ -43,7 +44,6 @@ jobs: components: clippy - run: cargo clippy --all --all-features -- -D warnings - doc: runs-on: ubuntu-latest steps: diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1d013ff --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). diff --git a/Cargo.lock b/Cargo.lock index 0183615..0255f28 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -684,7 +684,7 @@ checksum = "5ede67b28608b4c60685c7d54122d4400d90f62b40caee7700e700380a390fa8" [[package]] name = "rustls-rustcrypto" -version = "0.1.0" +version = "0.0.1-alpha" dependencies = [ "aead", "aes-gcm", diff --git a/Cargo.toml b/Cargo.toml index b50d4a9..985721c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,18 @@ [package] name = "rustls-rustcrypto" -version = "0.1.0" -edition = "2021" +description = """ +Pure Rust cryptography provider for the Rustls TLS library using algorithm implementations from the +RustCrypto organization +""" +version = "0.0.1-alpha" +authors = ["RustCrypto Developers"] license = "MIT OR Apache-2.0" +readme = "README.md" +repository = "https://github.com/RustCrypto/rustls-rustcrypto" +categories = ["cryptography", "no-std"] +keywords = ["rustls", "tls"] +edition = "2021" +rust-version = "1.75" # Ensure all dependencies + feats are mapped to crate features for correct usage # default features often have std breaking no_std and potentially other unwanted diff --git a/README.md b/README.md index d2e2a7c..59730d8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # rustls-rustcrypto +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Build Status][build-image]][build-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Project Chat][chat-image]][chat-link] + [RustCrypto]-based provider implementation for version 0.23 of [rustls], maintained by the RustCrypto organization. ## ⚠️USE THIS AT YOUR OWN RISK! DO NOT USE THIS IN PRODUCTION⚠️ @@ -49,5 +56,20 @@ Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. +[//]: # (badges) + +[crate-image]: https://buildstats.info/crate/rustls-rustcrypto +[crate-link]: https://crates.io/crates/rustls-rustcrypto +[docs-image]: https://docs.rs/rustls-rustcrypto/badge.svg +[docs-link]: https://docs.rs/rustls-rustcrypto/ +[build-image]: https://github.com/RustCrypto/rustls-rustcrypto/actions/workflows/rustls-rustcrypto.yml/badge.svg +[build-link]: https://github.com/RustCrypto/rustls-rustcrypto/actions/workflows/rustls-rustcrypto.yml +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.75+-blue.svg +[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg +[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/434751-TLS + +[//]: # (links) + [RustCrypto]: https://github.com/RustCrypto/ -[rustls]: https://github.com/rustls/rustls/pull/1405 +[rustls]: https://github.com/rustls/rustls/