From 8b9aceb312b25d0fc26b421e3c26bec4d95c7b64 Mon Sep 17 00:00:00 2001 From: Clombrong Date: Sun, 29 Jun 2025 08:46:20 +0200 Subject: docs(dune): remove warning about TCP --- dune-project | 10 +++------- portal-tcp.opam | 9 ++------- portal-websockets.opam | 3 ++- 3 files changed, 7 insertions(+), 15 deletions(-) diff --git a/dune-project b/dune-project index 65a7a75..96234e6 100644 --- a/dune-project +++ b/dune-project @@ -53,7 +53,7 @@ In turn, the Portal module can implement various transports to XMPP (WebSockets, (package (name portal-websockets) (synopsis "WebSockets XMPP portal") - (description "This library implements an XMPP Portal for Websockets.") + (description "This library implements an XMPP Portal for the Websocket subprotocol.") (depends ocaml dune @@ -67,12 +67,8 @@ In turn, the Portal module can implement various transports to XMPP (WebSockets, (package (name portal-tcp) - (synopsis "Plain TCP XMPP portal") - (description "This library implements an XMPP Portal for plain TCP. - -This package sends your credential over unsecured plaintext wire. - -You should probably not use this unless you know what you're doing.") + (synopsis "TCP XMPP portal") + (description "This library implements an XMPP Portal for TCP transports.") (depends ocaml dune diff --git a/portal-tcp.opam b/portal-tcp.opam index fe48e81..a4029bf 100644 --- a/portal-tcp.opam +++ b/portal-tcp.opam @@ -1,12 +1,7 @@ # This file is generated by dune, edit dune-project instead opam-version: "2.0" -synopsis: "Plain TCP XMPP portal" -description: """ -This library implements an XMPP Portal for plain TCP. - -This package sends your credential over unsecured plaintext wire. - -You should probably not use this unless you know what you're doing.""" +synopsis: "TCP XMPP portal" +description: "This library implements an XMPP Portal for TCP transports." maintainer: ["Clombrong"] authors: ["Clombrong"] license: "LGPL-3.0-or-later" diff --git a/portal-websockets.opam b/portal-websockets.opam index e95bb1b..e50eb40 100644 --- a/portal-websockets.opam +++ b/portal-websockets.opam @@ -1,7 +1,8 @@ # This file is generated by dune, edit dune-project instead opam-version: "2.0" synopsis: "WebSockets XMPP portal" -description: "This library implements an XMPP Portal for Websockets." +description: + "This library implements an XMPP Portal for the Websocket subprotocol." maintainer: ["Clombrong"] authors: ["Clombrong"] license: "LGPL-3.0-or-later" -- cgit v1.2.3