`_:",
+
+ * Jairo Llopis
+ * Vicent Cubells
+ * Víctor Martínez
diff --git a/html_text/readme/DESCRIPTION.rst b/html_text/readme/DESCRIPTION.rst
new file mode 100644
index 000000000..579fd7667
--- /dev/null
+++ b/html_text/readme/DESCRIPTION.rst
@@ -0,0 +1,7 @@
+This module provides some technical features that allow to extract text from
+any chunk of HTML, without HTML tags or attributes. You can chose either:
+
+* To truncate the result by amount of words or characters.
+* To append an ellipsis (or any character(s)) at the end of the result.
+
+It can be used to easily generate excerpts.
diff --git a/html_text/readme/ROADMAP.rst b/html_text/readme/ROADMAP.rst
new file mode 100644
index 000000000..0a77fddef
--- /dev/null
+++ b/html_text/readme/ROADMAP.rst
@@ -0,0 +1,2 @@
+* An option could be added to try to respect the basic HTML tags inside the
+ excerpt (````, ````, ````, etc.).
diff --git a/html_text/readme/USAGE.rst b/html_text/readme/USAGE.rst
new file mode 100644
index 000000000..ae34a9b25
--- /dev/null
+++ b/html_text/readme/USAGE.rst
@@ -0,0 +1,21 @@
+This module just adds a technical utility, but nothing for the end user.
+
+If you are a developer and need this utility for your module, see these
+examples and read the docs inside the code.
+
+Python example::
+
+ def some_method(self):
+ # Get truncated text from an HTML field. It will 40 words and 100
+ # characters at most, and will have "..." appended at the end if it
+ # gets truncated.
+ truncated_text = self.env["ir.fields.converter"].text_from_html(
+ self.html_field, 40, 100, "...")
+
+QWeb example::
+
+
+
+.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
+ :alt: Try me on Runbot
+ :target: https://runbot.odoo-community.org/runbot/149/11.0
diff --git a/html_text/tests/test_extractor.py b/html_text/tests/test_extractor.py
index d81b88765..1f0b7c91c 100644
--- a/html_text/tests/test_extractor.py
+++ b/html_text/tests/test_extractor.py
@@ -7,7 +7,7 @@ from odoo.tools import mute_logger
class ExtractorCase(TransactionCase):
def setUp(self):
- super(ExtractorCase, self).setUp()
+ super().setUp()
# Shortcut
self.text_from_html = self.env["ir.fields.converter"].text_from_html
@@ -24,7 +24,6 @@ class ExtractorCase(TransactionCase):