summaryrefslogtreecommitdiffstats
path: root/third_party/rust/nss-gk-api/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/nss-gk-api/README.md')
-rw-r--r--third_party/rust/nss-gk-api/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/third_party/rust/nss-gk-api/README.md b/third_party/rust/nss-gk-api/README.md
new file mode 100644
index 0000000000..f86711a931
--- /dev/null
+++ b/third_party/rust/nss-gk-api/README.md
@@ -0,0 +1,6 @@
+# (UNSTABLE) Gecko API for NSS
+
+nss-gk-api is intended to provide a safe and idiomatic Rust interface to NSS. It is based on code from neqo-crypto, but has been factored out of mozilla-central so that it can be used in standalone applications and libraries such as authenticator-rs. That said, it is *primarily* for use in Gecko, and will not be extended to support arbitrary use cases.
+
+This is work in progress and major changes are expected. In particular, a new version of the `nss-sys` crate will be factored out of this crate.
+