mirror of
https://github.com/gapmiss/iconoir-icons.git
synced 2026-07-22 08:00:25 +00:00
Update README.md
This commit is contained in:
parent
fadb397bca
commit
00c8f0fd22
1 changed files with 7 additions and 3 deletions
10
README.md
10
README.md
|
|
@ -8,10 +8,14 @@ A plugin for creating & displaying customized SVG [Iconoir Icons](https://iconoi
|
|||
>
|
||||
> This is the 1st released version (beta) of this plugin. The plugin does not delete or remove any data in a note, but does change the display in the `reading` view. It has NOT been tested w/ `Live Preview` and it is presumed that there are display issues when using `Live Preview`. Other caveats are listed below.
|
||||
|
||||
---
|
||||
|
||||
> Iconoir
|
||||
> Copyright (c) 2023 Luca Burgio - https://iconoir.com
|
||||
> License - https://github.com/lucaburgio/iconoir/blob/main/LICENSE (Code: MIT License)
|
||||
|
||||
--
|
||||
|
||||
## features
|
||||
|
||||
### icon search suggestions
|
||||
|
|
@ -183,9 +187,9 @@ strong {
|
|||
|
||||
## plugin installation
|
||||
|
||||
1. download the latest [release archive](https://github.com/gapmiss/iconoir-icons/releases)
|
||||
1. download the latest [release archive](https://github.com/gapmiss/iconoir-icons/releases/download/0.0.1/iconoir-icons-v0.0.1.zip)
|
||||
2. uncompress the downloaded archive
|
||||
3. move the enclosed `iconoir-icons` folder to `/path/to/vault/.obsidian/plugins/`
|
||||
3. move the `iconoir-icons` folder to `/path/to/vault/.obsidian/plugins/`
|
||||
4. Settings > Community plugins > reload **Installed plugins**
|
||||
5. enable plugin
|
||||
|
||||
|
|
@ -221,4 +225,4 @@ npm run dev
|
|||
|
||||
## caveats
|
||||
|
||||
- 2023-02-09 None known at this time.
|
||||
- 2023-02-09 None known at this time.
|
||||
|
|
|
|||
Loading…
Reference in a new issue