Skip to content

Commit a91032f

Browse files
author
quantra
committed
Quick README.rst update.
1 parent c3f8d2e commit a91032f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Lazy srcset and image generation for Django. Minimum effort required. No databas
66

77
Django Lazy srcset will create all the markup and images you need to provide responsive images via the srcset attribute. All you need to do is install it, configure your breakpoints and use the ``{% srcset %}`` template tag.
88

9-
All of the hard work (image generation and cacheing) is done by django-imagekit, by default this means images are generated just in time - lazily. Please see the `django-imagekit docs<https://django-imagekit.readthedocs.io>`_ for more info and configuration options.
9+
All of the hard work (image generation and cacheing) is done by django-imagekit, by default this means images are generated just in time - lazily. Please see the `django-imagekit docs <https://django-imagekit.readthedocs.io>`_ for more info and configuration options.
1010

1111
SVG images are supported, they will not be converted or resized but width and height attributes are still generated.
1212

@@ -60,16 +60,16 @@ Use the ``{% srcset %}`` template tag:
6060
{# image is probably an ImageField #}
6161
<img {% srcset image %} alt="Lovely and lazy" />
6262
63-
{# You can also provide relative image widths e.g. 4 - 3 - 2 - 1 col #}
64-
<img {% srcset image 25 33 50%} />
63+
{# You can also provide relative image widths e.g. for a 4 - 3 - 2 - 1 col degradation: #}
64+
<img {% srcset image 25 33 50 %} />
6565
6666
{# You can provide a path to a static file #}
6767
<img {% srcset 'path/to/my/image.png' %} />
6868
6969
Whilst not required it is advisable to take a nap at this stage.
7070

71-
For further documentation and usage examples please read the source code for ``lazy_srcset/templatetags/lazy_srcset.py``.
71+
For further documentation and usage examples please read the source code for `lazy_srcset/templatetags/lazy_srcset.py <https://github.com/Quantra/django-lazy-srcset/blob/master/lazy_srcset/templatetags/lazy_srcset.py#L98>`_.
7272

73-
Currently imagekit ``SourceGroup`` has not been implemented therefore the imagekit ``generateimages`` management command will not generate images for django-lazy-srcset. If you want to pre-generate images you can use ``render_to_string()`` your templates in an appropriate save method or signal. If you are using django-content-blocks this happens on publish anyway.
73+
Currently imagekit ``SourceGroup`` has not been implemented therefore the imagekit ``generateimages`` management command will not generate images for django-lazy-srcset. If you want to pre-generate images you can ``render_to_string()`` your templates in an appropriate save method or signal. If you are using django-content-blocks this happens on publish anyway.
7474

7575
Clean up of unused files created by django-lazy-srcset is down to you, if you require it at all.

0 commit comments

Comments
 (0)