From 9392391dd580be60cb6e2efc2293db82b9e4badf Mon Sep 17 00:00:00 2001 From: Nguyễn Gia Phong Date: Sat, 21 Oct 2023 07:44:42 +0900 Subject: Replace dependencies Bleach has been deprecated along with html5lib, and its replacement nh3 lacks the linkify function, so mistune is used for markdown for its url plugin. --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4e05c61..fa218f0 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@ for rendering email replies on websites and their [RSS] feed. ## Prerequisites -This Python package depends on [bleach] for HTML sanitising -and [markdown] for, well, rendering Markdown to HTML. It is, however, +This Python package depends on [nh3] for HTML sanitization +and [mistune] for rendering Markdown to HTML. It is, however, not designed to work with HTML emails with all those CSS and Java scripts. ## Installation It is recommended to install this package from a downstream repository, -such as [Nix] or [IPWHL]. +such as [nixpkgs]. ## Usage @@ -40,7 +40,6 @@ by the Free Software Foundation, either version 3 of the License, or [mbox]: https://en.wikipedia.org/wiki/Mbox [RSS]: https://www.rssboard.org -[bleach]: https://bleach.readthedocs.io -[markdown]: https://python-markdown.github.io -[Nix]: https://search.nixos.org/packages?channel=unstable&query=formbox -[IPWHL]: https://man.sr.ht/~cnx/ipwhl +[nh3]: https://nh3.readthedocs.io +[mistune]: https://mistune.lepture.com +[nixpkgs]: https://search.nixos.org/packages?channel=unstable&query=formbox -- cgit 1.4.1