diff --git a/README.md b/README.md index 7b2d211d..eb77627c 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,80 @@ -# Runes Webkit +# Flowbite Svelte Icons -A collection of reusable Svelte components for building user interfaces for Svelte Runes web applications. +
-- CodeWrapper -- Footer -- helpers -- HighlightCompo -- HomeCards -- IconPage -- SupportBanner -- TechInfo +480+ SVG [Flowbite icons](https://github.com/themesberg/flowbite-icons) components for Svelte 3/4/5/Runes. +Thank you for considering my open-source package. If you use it in a commercial project, please support me by sponsoring me on GitHub: https://github.com/sponsors/shinokada. Your support helps me maintain and improve this package for the benefit of the community. + +## Docs + +Please see the [Flowbite Svelte Icons documentation](https://flowbite-svelte-icons.codewithshin.com/) for more details on using the icons in your Svelte application. + +## Icons + +- [Outline Icons](https://flowbite-svelte-icons.codewithshin.com/outline) +- [Solid Icons](https://flowbite-svelte-icons.codewithshin.com/solid) + +## Repo + +[GitHub Repo](https://github.com/themesberg/flowbite-svelte-icons) + +## Original source + +[themesberg/flowbite-icons](https://github.com/themesberg/flowbite-icons) ## Requirements -- Svelte 5 (Runes) -- SvelteKit +### v1 +- Svelte 4/5 +- TailwindCSS + +### v2 +- Svelte 5:Runes +- TailwindCSS ## Installation + +### Svelte 4/5 + ```sh -pnpm i -D runes-webkit svelte-rune-highlight highlight.js -``` \ No newline at end of file +pnpm i -D flowbite-svelte-icons +``` + +### Svelte 5 Runes + +```sh +pnpm i -D flowbite-svelte-icons@2.0.0-next.x +``` + +Replace `2.0.0-next.x` with the latest `v2` version. +Replace `x` with the latest release at [GitHub](https://github.com/themesberg/flowbite-svelte-icons/releases). + +Add the following to tailwind.config.cjs. + +```js +const config = { + content: [ + // more lines + "./node_modules/flowbite-svelte-icons/**/*.{html,js,svelte,ts}", + ], + // more lines +} +``` + +## Other icons + +- [Svelte-Icon-Sets](https://svelte-svg-icons.codewithshin.com/) + +## License + +[Flowbite-Svelte-Icons License](https://github.com/themesberg/flowbite-svelte-icons/blob/main/LICENSE) + +[Flowbite Icons License](https://github.com/themesberg/flowbite-icons/blob/main/LICENSE) \ No newline at end of file