README.md: initial version

rustls-libssl/README.md

@@ -1 +1,50 @@
-# temporary
+<p align="center">
+  <img width="460" height="300" src="https://raw.githubusercontent.com/rustls/rustls/main/admin/rustls-logo-web.png">
+</p>
+
+rustls-libssl is a partial reimplementation of the OpenSSL 3 libssl ABI.
+It is written in rust and uses rustls.  It does not replace libcrypto:
+this is still required.
+
+[![rustls-libssl](https://github.com/rustls/rustls-openssl-compat/actions/workflows/libssl.yaml/badge.svg)](https://github.com/rustls/rustls-openssl-compat/actions/workflows/libssl.yaml)
+
+# Status
+
+This project is experimental.  We have aimed for the subset of libssl
+used by curl and nginx versions as shipped with Ubuntu 22.04 LTS.
+We have a [MATRIX.md](the compatibility matrix) and
+[https://github.com/rustls/rustls-openssl-compat/issues](known issues).
+
+# Usage
+
+## Installation
+```shell
+$ curl https://github.com/rustls/rustls-openssl-compat/releases/latest/download/rustls-libssl_amd64.deb
+$ sudo dpkg -i rustls-libssl_amd64.deb
+```
+
+Using curl:
+
+```shell
+$ with-rustls-libssl curl https://google.com/
+```
+
+`with-rustls-libssl` just sets `LD_LIBRARY_PATH` and executes the given process.
+
+Using nginx:
+
+```shell
+$ sudo rustls-libssl-nginx enable
+$ sudo systemctl daemon-reload
+$ sudo service nginx restart
+```
+
+`rustls-libssl-nginx enable` installs a systemd drop-in in `/etc/systemd/system/nginx.service.d/`.
+`rustls-libssl-nginx disable` undoes that.
+
+# Changelog
+The detailed list of changes in each release can be found at
+https://github.com/rustls/rustls-openssl-compat/releases.
+
+# License
+rustls-libssl is distributed under the Apache-2.0 license. See [LICENSE][].