@tabler/icons-svelte 2.0.0-beta → 2.0.0

package/README.md

@@ -0,0 +1,80 @@
+# Tabler Icons for Svelte
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/tabler/tabler-icons/master/.github/packages/og-package-svelte.png" alt="Tabler Icons" width="838">
+</p>
+
+<p align="center">
+Implementation of the Tabler Icons library for Svelte applications.
+<p>
+
+<p align="center">
+  <a href="https://tabler-icons.io/"><strong>Browse all icons at tabler-icons.io &rarr;</strong></a>
+</p>
+
+<p align="center">
+    <a href="https://github.com/tabler/tabler-icons/releases"><img src="https://img.shields.io/npm/v/@tabler/icons" alt="Latest Release"></a>
+    <a href="https://github.com/tabler/tabler-icons/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@tabler/icons.svg" alt="License"></a>
+</p>
+
+## Sponsors
+
+**If you want to support my project and help me grow it, you can [become a sponsor on GitHub](https://github.com/sponsors/codecalm) or just [donate on PayPal](https://paypal.me/codecalm) :)**
+
+<a href="https://github.com/sponsors/codecalm">
+  <img src='https://raw.githubusercontent.com/tabler/static/main/sponsors.png'>
+</a>
+
+## Installation
+
+```
+yarn add @tabler/icons-svelte
+```
+
+or
+
+```
+npm install @tabler/icons-svelte
+```
+
+or
+
+```
+pnpm install @tabler/icons-svelte
+```
+
+or just [download from Github](https://github.com/tabler/tabler-icons/releases).
+
+## How to use
+
+It's build with ESmodules so it's completely tree-shakable. Each icon can be imported as a component.
+
+```sveltehtml
+<script lang="ts">
+import { IconHeart } from '@tabler/icons-svelte';
+</script>
+
+<main>
+  <IconHeart />
+</main>
+```
+
+You can pass additional props to adjust the icon.
+
+```html
+<IconHeart size={48} strokeWidth={1} />
+```
+
+## Contributing
+
+For more info on how to contribute please see the [contribution guidelines](https://github.com/tabler/tabler-icons/blob/main/CONTRIBUTING.md).
+
+Caught a mistake or want to contribute to the documentation? [Edit this page on Github](https://github.com/tabler/tabler-icons/blob/main/packages/icons-svelte/README.md)
+
+## License
+
+Tabler Icons is licensed under the [MIT License](https://github.com/tabler/tabler-icons/blob/master/LICENSE).
+
+## Sponsor Tabler
+
+<a href="https://github.com/sponsors/codecalm" target="_blank"><img src="https://github.com/tabler/tabler/raw/dev/src/static/sponsor-banner-readme.png?raw=true" alt="Sponsor Tabler" /></a>