Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
shinokada committed Apr 27, 2024
1 parent 05c40ac commit 9b03d49
Showing 1 changed file with 70 additions and 14 deletions.
84 changes: 70 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,80 @@
# Runes Webkit
# Flowbite Svelte Icons

A collection of reusable Svelte components for building user interfaces for Svelte Runes web applications.
<div class="flex gap-2 my-8">
<a href="https://github.com/sponsors/shinokada" target="_blank"><img src="https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86" alt="sponsor" ></a>
<a href="https://www.npmjs.com/package/flowbite-svelte-icons" rel="nofollow" target="_blank"><img src="https://img.shields.io/npm/v/flowbite-svelte-icons" alt="npm" ></a>
<a href="https://twitter.com/shinokada" rel="nofollow" target="_blank"><img src="https://img.shields.io/badge/created%[email protected]" alt="Created by Shin Okada" ></a>
<a href="https://opensource.org/licenses/MIT" rel="nofollow" target="_blank"><img src="https://img.shields.io/github/license/shinokada/flowbite-svelte-icons" alt="License" ></a>
<a href="https://www.npmjs.com/package/flowbite-svelte-icons" rel="nofollow" target="_blank"><img src="https://img.shields.io/npm/dw/flowbite-svelte-icons.svg" alt="npm" ></a>
</div>

- 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
```
pnpm i -D flowbite-svelte-icons
```

### Svelte 5 Runes

```sh
pnpm i -D [email protected]
```

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)

0 comments on commit 9b03d49

Please sign in to comment.