diff --git a/README.md b/README.md index 5b2741e..e51b253 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ ![](static/og.jpg) + + +[![npm version](https://flat.badgen.net/npm/v/vaul-svelte?color=green)](https://npmjs.com/package/vaul-svelte) +[![npm downloads](https://flat.badgen.net/npm/dm/vaul-svelte?color=green)](https://npmjs.com/package/vaul-svelte) +[![license](https://flat.badgen.net/github/license/huntabyte/vaul-svelte?color=green)](https://github.com/huntabyte/vaul-svelte/blob/main/LICENSE) + + + Vaul-Svelte is an unstyled drawer component for Svelte that can be used as a Dialog replacement on tablet and mobile devices. It uses [Bits' Dialog primitive](https://www.bits-ui.com/docs/components/dialog) under the hood and is inspired by [this tweet](https://twitter.com/devongovett/status/1674470185783402496). This is a port of [Vaul](https://github.com/emilkowalski/vaul) for React, which was created by [Emil Kowalski](https://twitter.com/emilkowalski_). @@ -89,3 +97,26 @@ The button that closes the dialog. [Props](https://www.bits-ui.com/docs/componen ### Portal Portals your drawer into the body. + +## Sponsors + +This project is supported by the following beautiful people/organizations: + +

+ + Logos from Sponsors + +

+ +## License + + + +Published under the [MIT](https://github.com/huntabyte/vaul-svelte/blob/main/LICENSE) license. +Made by [@huntabyte](https://github.com/huntabyte) and [community](https://github.com/huntabyte/vaul-svelte/graphs/contributors) 💛 +

+ + + + +