From 8ff62a92fae7105febc0208ca0ef15f0471661e1 Mon Sep 17 00:00:00 2001 From: Dominik George <dominik.george@teckids.org> Date: Tue, 16 Feb 2021 01:16:35 +0100 Subject: [PATCH] Add note on example to README. --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index aa80ddc..325622f 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 -- GitLab