diff --git a/README.rst b/README.rst index aa80ddc7f90e00ad3be1b0cbb94a804f2804742b..325622f6b14f6e8e518c57128fe9614c14e65609 100644 --- a/README.rst +++ b/README.rst @@ -101,6 +101,14 @@ In the future, a template tag will be available to render SVG icons directly into the template, which can be helpful in situations where retrieving external resources in undesirable, like HTML e-mails. +Example +------- + +The source distribution as well as the `Git repository` contain a full example +application that serves the API under `/icons/` and a test page under `/test.html`. + +It is reduced to a minimal working example for the reader's convenience. + _`Iconify`: https://iconify.design/ _`django-iconify`: https://edugit.org/AlekSIS/libs/django-iconify _`poetry`: https://python-poetry.org/ @@ -108,3 +116,4 @@ _`JSON collection`: https://github.com/iconify/collections-json _`django-yarnpkg`: https://edugit.org/AlekSIS/libs/django-yarnpkg _`Iconify SVG Framework`: https://docs.iconify.design/implementations/svg-framework/ _`How to use Iconify in CSS`: https://docs.iconify.design/implementations/css.html +_`Git repository`: https://edugit.org/AlekSIS/libs/django-iconify