aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Benjamin Barenblat <bbaren@google.com>2018-03-28 11:48:05 -0400
committerGravatar Benjamin Barenblat <bbaren@google.com>2018-03-28 11:48:05 -0400
commit85a1090d6cbdb8924554fecc028dbb2f41fa966c (patch)
treefb9194f6ba7ecc1e0206fa2bdf13249b8d2796cb /README.md
parent7aeeadd0647bfa649b9af859fe5dd7b5cc52afe9 (diff)
Apply Apache License
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..479da5a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# btls
+
+btls is a TLS and cryptography library for Haskell. It’s built on top of
+[BoringSSL](https://boringssl.googlesource.com/boringssl), Google’s audited fork
+of OpenSSL.
+
+Although BoringSSL does not have a stable API or ABI, we expect that btls will
+converge to a stable API before we release btls version 1. In the meantime, the
+API remains unstable, we do not follow the [Package Versioning
+Policy](https://pvp.haskell.org), and we will not post btls on Hackage.
+
+**btls is not production ready yet.** It is feature-incomplete and has not
+undergone review or auditing.
+
+---
+
+This is not an official Google product.
+
+This product includes cryptographic software written by [Eric
+Young](mailto:eay@cryptsoft.com).
+
+This product includes software written by [Tim
+Hudson](mailto:tjh@cryptsoft.com).
+
+This product includes software developed by the OpenSSL Project for use in the
+[OpenSSL Toolkit](https://www.openssl.org).