Skip to content

Commit e22039b

Browse files
authored
chore: update readme (#61)
1 parent e581fec commit e22039b

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
![](static/og.jpg)
22

3+
<!-- automd:badges license name="vaul-svelte" color="green" github="huntabyte/vaul-svelte" -->
4+
5+
[![npm version](https://flat.badgen.net/npm/v/vaul-svelte?color=green)](https://npmjs.com/package/vaul-svelte)
6+
[![npm downloads](https://flat.badgen.net/npm/dm/vaul-svelte?color=green)](https://npmjs.com/package/vaul-svelte)
7+
[![license](https://flat.badgen.net/github/license/huntabyte/vaul-svelte?color=green)](https://github.com/huntabyte/vaul-svelte/blob/main/LICENSE)
8+
9+
<!-- /automd -->
10+
311
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).
412

513
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
8997
### Portal
9098

9199
Portals your drawer into the body.
100+
101+
## Sponsors
102+
103+
This project is supported by the following beautiful people/organizations:
104+
105+
<p align="center">
106+
<a href="https://github.com/sponsors/huntabyte">
107+
<img src='https://cdn.jsdelivr.net/gh/huntabyte/static/sponsors.svg' alt="Logos from Sponsors" />
108+
</a>
109+
</p>
110+
111+
## License
112+
113+
<!-- automd:contributors license=MIT author="huntabyte" github="huntabyte/vaul-svelte" -->
114+
115+
Published under the [MIT](https://github.com/huntabyte/vaul-svelte/blob/main/LICENSE) license.
116+
Made by [@huntabyte](https://github.com/huntabyte) and [community](https://github.com/huntabyte/vaul-svelte/graphs/contributors) 💛
117+
<br><br>
118+
<a href="https://github.com/huntabyte/vaul-svelte/graphs/contributors">
119+
<img src="https://contrib.rocks/image?repo=huntabyte/vaul-svelte" />
120+
</a>
121+
122+
<!-- /automd -->

0 commit comments

Comments
 (0)