Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gohugoio/hugo-mod-heroicons.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 2 insertions, 6 deletions
diff --git a/README.md b/README.md
index e7843aa..0cf9a55 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,10 @@
-Work in progress: Provides Heroicons as a simple to use Hugo Module
-
Heroicons is a set of free MIT-licensed high-quality SVG icons for you to use in your web projects.
140 icons per style currently, more to come in the future. See https://github.com/refactoringui/heroicons
-
## Use
-Import it into your projec:
+Import the module into your Hugo project's site config:
```toml
[[module.imports]]
@@ -23,5 +20,4 @@ This means that they can be used like this in a Hugo template:
{{ $icon.Content | safeHTML }}
```
-
-See https://github.com/refactoringui/heroicons/tree/master/src for a full list of icons. \ No newline at end of file
+See https://github.com/refactoringui/heroicons/tree/master/src for a full list of icons.