aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorClombrong <cromblong@egregore.fun>2025-06-29 08:40:44 +0200
committerClombrong <cromblong@egregore.fun>2025-06-29 08:41:00 +0200
commit5fcd5db18a20a4e57451d3f824d2597556774925 (patch)
treeb7452ce2c351c9fe53e8b1b35db9a968ae0fdb4e /README.md
parent4d45ffa8cb2bf3065b4811e69aa59e6952c465d5 (diff)
docs: document FLESH_ALLOW_STRIPTLS
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index 9554d9d..6fe13ca 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,22 @@
# Flesh interface
> I will always regard the first instance of a flesh interface to have occurred in
-> [Triblenka](https://en.wikipedia.org/wiki/Treblinka_extermination_camp), 1944. The geologic disturbances, partial
-> tunnels, so-called interdimensionality, and wealth of clearly segmented bodies leave no doubt of its existence. The
-> Soviets have documented this.
+> [Triblenka](https://en.wikipedia.org/wiki/Treblinka_extermination_camp), 1944. The
+> geologic disturbances, partial tunnels, so-called interdimensionality, and wealth of
+> clearly segmented bodies leave no doubt of its existence. The Soviets have documented
+> this.
-_Flesh_ (or Flesh interface) is a high-level, cross-platform XMPP library, developed in pure OCaml.
+_Flesh_ (or Flesh interface) is a high-level, cross-platform XMPP library, developed in
+pure OCaml.
-One of the goals of _Flesh_ is to have code that can run natively on major operating systems, and compile with
-Js_of_ocaml for use in web applications.
+One of the goals of _Flesh_ is to have code that can run natively on major operating
+systems, and compile with Js_of_ocaml for use in web applications.
Later, it should be able to use Wasm_of_ocaml too.
OMEMO support is not a goal currently, but will be in the future.
+
+_Flesh_ supports STARTTLS, and by default, enforces the use of some form of TLS.
+
+To disable forced STARTTLS, set the `FLESH_ALLOW_STRIPTLS` environment variable to
+anything.