Skip to content

Commit

Permalink
chore: update readme (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
huntabyte authored Feb 24, 2024
1 parent e581fec commit e22039b
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
![](static/og.jpg)

<!-- automd:badges license name="vaul-svelte" color="green" github="huntabyte/vaul-svelte" -->

[![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)

<!-- /automd -->

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_).
Expand Down Expand Up @@ -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:

<p align="center">
<a href="https://github.com/sponsors/huntabyte">
<img src='https://cdn.jsdelivr.net/gh/huntabyte/static/sponsors.svg' alt="Logos from Sponsors" />
</a>
</p>

## License

<!-- automd:contributors license=MIT author="huntabyte" github="huntabyte/vaul-svelte" -->

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) 💛
<br><br>
<a href="https://github.com/huntabyte/vaul-svelte/graphs/contributors">
<img src="https://contrib.rocks/image?repo=huntabyte/vaul-svelte" />
</a>

<!-- /automd -->

0 comments on commit e22039b

Please sign in to comment.