obsidian-plugin/gapmiss_iconoir-icons
1
0
Fork 0
mirror of https://github.com/gapmiss/iconoir-icons.git synced 2026-07-22 08:00:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
gapmiss 2023-05-27 14:55:03 -04:00
parent f3f2bc700b
commit 03fa9a4be8
1 changed files with 8 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -4,9 +4,7 @@ A plugin for creating & displaying customized SVG [Iconoir Icons](https://iconoi
> ⚠️ NOTICE
>
> Iconoir
> Copyright (c) 2023 Luca Burgio - https://iconoir.com
> License - https://github.com/lucaburgio/iconoir/blob/main/LICENSE (Code: MIT License)
> Copyright (c) 2023 Luca Burgio - https://iconoir.com; License - https://github.com/lucaburgio/iconoir/blob/main/LICENSE (Code: MIT License)
## features
@ -29,13 +27,13 @@ The syntax for the icon component is:
The delimiter is the pipe symbol `|`.
ICON = the name of the icon e.g. iconoir-peace-hand
COLOR= the CSS color of the icon e.g. purple
W= the CSS width of the icon e.g. 1em
H= the CSS height of the icon e.g. 1em
STYLE = the CSS rule(s) for the icon component e.g. float:right;
ICON = the name of the icon e.g. iconoir-peace-hand
COLOR = the CSS color of the icon e.g. purple
W = the CSS width of the icon e.g. 1em
H = the CSS height of the icon e.g. 1em
STYLE = the CSS rule(s) for the icon component e.g. float:right;
ONLY the ICON name is required. ALL others optional.
ONLY the ICON name is required. ALL others optional, but cannot be empty.
`~![iconoir-peace-hand|purple|1em|1em|float:right;]`
```
@ -185,7 +183,7 @@ From Obsidian's settings or preferences:
or:
1. download the latest [release archive](https://github.com/gapmiss/iconoir-icons/releases/download/0.0.1/iconoir-icons-v0.0.1.zip)
1. download the latest [release archive](https://github.com/gapmiss/iconoir-icons/releases/download/1.0.0/iconoir-icons-v1.0.0.zip)
2. uncompress the downloaded archive
3. move the `iconoir-icons` folder to `/path/to/vault/.obsidian/plugins/`
4. Settings > Community plugins > reload **Installed plugins**