Add a formatted note to usage info for preload

django-compressor · Jan 1, 2021 · 1b1ee8d · 1b1ee8d
1 parent cd7898f
commit 1b1ee8d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/usage.txt b/docs/usage.txt
@@ -62,6 +62,11 @@ Result:
 
         <link rel="preload" href="/static/CACHE/js/d01466eb4fc6.js" as="script" />
 
+.. note::
+
+    This operation only generates the preload HTML link element with the correct filename hash.
+    You must subsequently load the file within a ``compress`` block to use the associated resource.
+
 Specifying a ``block_name`` will change the output filename. It can also be
 accessed in the :ref:`post_compress signal <signals>` in the ``context`` parameter.