From 748765a01091bc9d9aca426222e15627a40fe324 Mon Sep 17 00:00:00 2001 From: klve bunc ntnn Date: Wed, 8 Jun 2022 22:12:39 +0300 Subject: [PATCH] Added a quick description about the project --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9c231bf --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Poptea + +Poptea is a library for the [Gemini protocol](https://gemini.circumlunar.space/). The main goal of this project was to implement a trust on first use (TOFU) for TLS keys functionality. +This library is published as a crate at [crates.io](https://crates.io/search?q=poptea). +This library is used in another opensource project called [sic](https://github.com/epilys/sic). + +## Usage + +Please refer to [`./bin/poptea-cli.rs`](bin/poptea-cli.rs) for how to use the library in a client side application. -- 2.38.4