Skip to content

Commit

Permalink
Update README.md with docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tehsurfer authored Apr 16, 2024
1 parent 43e04c3 commit 84d9ffc
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# svg-sprite [![npm version](https://badge.fury.io/js/%40abi-software%2Fsvg-sprite.svg)](https://badge.fury.io/js/%40abi-software%2Fsvg-sprite)
An npm package used to bundle svg icons into the a Vite-Vue3 build. This is opposed to loading svg's from the server at runtime, which can end up SVGs loading last on a site.

View the a live demo and documentation at: https://abi-software.github.io/svg-sprite/

## Using svg-sprite
svg-sprite currently only works for SVGs included in the [assets/icons](https://github.com/ABI-Software/svg-sprite/tree/main/assets/icons) directory

Expand Down

0 comments on commit 84d9ffc

Please sign in to comment.