From 3e2d4707299bfc82fd3925a31f045131fc729d4f Mon Sep 17 00:00:00 2001 From: Dirkjan Ochtman Date: Thu, 12 May 2022 11:00:43 +0200 Subject: [PATCH] Add a README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6c53fef --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# instant-acme: async, pure-Rust ACME client + +[![Documentation](https://docs.rs/instant-acme/badge.svg)](https://docs.rs/instant-acme/) +[![Crates.io](https://img.shields.io/crates/v/instant-acme.svg)](https://crates.io/crates/instant-acme) +[![Build status](https://github.com/InstantDomain/instant-acme/workflows/CI/badge.svg)](https://github.com/InstantDomain/instant-acme/actions?query=workflow%3ACI) +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE-APACHE) + +instant-acme is an async, pure-Rust ACME (RFC 8555) client. + +instant-acme is used in production at [InstantDomain](https://instantdomain.com/) to help +us provision TLS certificates within seconds for our customers. instant-acme relies +on Tokio and rustls to implement the [RFC 8555](https://www.rfc-editor.org/rfc/rfc8555.html) +specification. + +## Features + +* Store/recover your account credentials by serializing/deserializing +* Fully async implementation with tracing support +* Support for processing multiple orders concurrently +* Uses hyper with rustls and Tokio for HTTP requests +* Uses *ring* for ECDSA signing +* Minimum supported Rust version: 1.51 + +## Limitations + +* Only tested with DNS challenges against Let's Encrypt so far (staging and production) +* Only supports ECDSA keys for now