Skip to content

Commit 844a353

Browse files
committed
Readme for v2 release
1 parent 218e5f6 commit 844a353

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
<p align="center">
22
<img src="https://github.com/ciscoheat/sveltekit-superforms/raw/main/logo.svg" width="150px" align="center" alt="Superforms logo" />
33
<h1 align="center">Superforms 💥</h1>
4+
<p align="center">Making SvelteKit forms a pleasure to use!</p>
45
</p>
56

67
<div align="center">
78
<a align="center" href="https://superforms.rocks/">https://superforms.rocks/</a>
89
<br />
9-
<a href="https://discord.gg/AptebvVuhB">Discord</a>
10+
<a href="https://discord.gg/g5GHjGtU2W">Discord</a>
1011
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
1112
<a href="https://superforms.rocks/api">API</a>
1213
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
@@ -17,25 +18,23 @@
1718
<a href="https://github.com/ciscoheat/sveltekit-superforms/issues">Issues</a>
1819
</div>
1920

20-
<p align="center">Making SvelteKit forms a pleasure to use!</p>
21-
2221
# Feature list
2322

23+
- Server- and client-side validation with your favorite validation libraries, and more to come: 💥 **Arktype** 💥 **Joi** 💥 **TypeBox** 💥 **Valibot** 💥 **Yup** 💥 **Zod** 💥
2424
- Seamless merging of `PageData` and `ActionData` - Forget about which one to use and how, just focus on your form data.
25-
- Server- and client-side validation with any of your favorite validation libraries, with more to come: 💥 **Arktype** 💥 **Joi** 💥 **TypeBox** 💥 **Valibot** 💥 **Yup** 💥 **Zod** 💥
26-
- [Auto-centering and auto-focusing](https://superforms.rocks/concepts/error-handling#usage-client) on invalid form fields.
27-
- [Tainted form detection](https://superforms.rocks/concepts/tainted), prevents the user from losing data if navigating away from an unsaved form.
28-
- No JavaScript required as default, but full support for [progressive enhancement](https://superforms.rocks/concepts/enhance).
29-
- Automatically coerces the string data from `FormData` into correct types.
30-
- For advanced data structures, forget about the limitations of `FormData` - [Send your forms as devalued JSON](https://superforms.rocks/concepts/nested-data), transparently.
25+
- [Auto-centering and focusing](https://superforms.rocks/concepts/error-handling#usage-client) on invalid form fields.
26+
- [Tainted form detection](https://superforms.rocks/concepts/tainted), prevents the user from losing data if navigating away from an unsaved form. Or use [snapshots](https://superforms.rocks/concepts/snapshots) to save the form state.
27+
- Automatically coerces the `FormData` into correct types.
28+
- For advanced data structures, forget about the limitations of `FormData` - Use [nested data structures](https://superforms.rocks/concepts/nested-data) transparently.
3129
- Generates [default form values](https://superforms.rocks/default-values) from validation schemas.
32-
- Support for [nested data structures](https://superforms.rocks/concepts/nested-data), [snapshots](https://superforms.rocks/concepts/snapshots) and [multiple forms](https://superforms.rocks/concepts/multiple-forms) on the same page.
30+
- Handles [multiple forms](https://superforms.rocks/concepts/multiple-forms) on the same page.
3331
- Works both on the server and with [single-page applications](https://superforms.rocks/concepts/spa) (SPA)!
3432
- [Proxy objects](https://superforms.rocks/concepts/proxy-objects) for handling data conversions to string and back again.
35-
- Realtime [client-side validation](https://superforms.rocks/concepts/client-validation) for immediate feedback.
33+
- Realtime [client-side validation](https://superforms.rocks/concepts/client-validation) for the best possible UX.
3634
- Create loading spinners easily with three [auto-updating timers](https://superforms.rocks/concepts/timers), based on human perception research.
3735
- Hook into [a number of events](https://superforms.rocks/concepts/events) for full control over the validation data and the `ActionResult`, with a possibility to cancel the update at every step.
3836
- Complete customization with a [huge list of options](https://superforms.rocks/api#superformform-options).
37+
- No JavaScript required as default, but full support for [progressive enhancement](https://superforms.rocks/concepts/enhance).
3938
- Comes with a Super Debugging Svelte Component: [SuperDebug](https://superforms.rocks/super-debug).
4039

4140
# Get started
@@ -44,14 +43,14 @@ Follow the Get started tutorial on the website to get a hands-on introduction to
4443

4544
You can also watch this excellent introduction video to see what's possible: https://www.youtube.com/watch?v=MiKzH3kcVfs
4645

47-
# Contributing
46+
# Help & support
4847

49-
General feedback, feature requests, bug reports, PR:s, are very welcome as a Github [issue](https://github.com/ciscoheat/sveltekit-superforms/issues) or on the [Discord server](https://discord.gg/AptebvVuhB)!
48+
- If you're using Superforms in non-profit circumstances, support is completely free; a star on [Github](https://github.com/ciscoheat/sveltekit-superforms) is more than enough to show your appreciation. Join the [#free-support](https://discord.gg/8X9Wfb2wbz) channel on Discord and ask away!
49+
- If you're making or aiming to make money on your project, a donation proportional to the current profit of the project or the company you work for, will give you a month of commercial support. Donate with one of the options [on the website](https://superforms.rocks/support#commercial-support), then ask in the [#commercial-support](https://discord.gg/m6hUXE4eNQ) channel on Discord.
5050

51-
# Help & support
51+
# Contributing
5252

53-
- If you're using Superforms in non-profit circumstances, support is completely free; a star on [Github](https://github.com/ciscoheat/sveltekit-superforms) is more than enough to show your appreciation. Join the #free-support channel on Discord and ask away!
54-
- If you're making or aiming to make money on your project, a donation proportional to the current profit of the project or the company you work for, will give you a month of commercial support. Donate with one of the options [on the website](https://superforms.rocks/support#commercial-support), then ask in the #commercial-support channel on Discord.
53+
General feedback, feature requests, bug reports, PR:s, are very welcome as a Github [issue](https://github.com/ciscoheat/sveltekit-superforms/issues) or on the [Discord server](https://discord.gg/g5GHjGtU2W)!
5554

5655
# Donating
5756

0 commit comments

Comments
 (0)