search

jmuchovej / typst-iconify

Support for Iconify JSON in Typst
1 stars 0 forks source link

šŸ“ Add usage instructions #1

Open rwmpelstilzchen opened 1 week ago

rwmpelstilzchen commented 1 week ago

Thanks for typst-iconify! ^^ While I havenā€™t used it yet, the idea is brilliant (much better than having different packages with different APIs for different icon sets).

The ā€˜Usageā€™ section of the readme is empty. How does one use this package, if itā€™s usable at its current state?

https://github.com/jmuchovej/typst-iconify/blob/789e2447459dc1fc4ce148ddc4dec14c8abdd216/readme.md?plain=1#L6-L8

jmuchovej commented 1 week ago

sorry for the slow reply ā€“Ā in the middle of conference season. šŸ˜… (if i can't find time to work on this in the next two weeks, i should be able to finish it up around the first week of december.)

right now the package is unusable. i need to rethink (a bit) how to structure the package since there's no way to do something like dynamic icon loading (e.g., user doesn't specify phosphor as a desired icon set but uses something like ph:app-window-duotone).

i also need to sort out how to minimize the footprint of packages so we don't run into issues of bloating typst/packages.