Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
logaretm committed Nov 16, 2024
1 parent f39a332 commit 55565a9
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,43 @@
SOON
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://formwerk.dev/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="https://formwerk.dev/logo-light.svg">
<img alt="Formwerk Logo" src="https://formwerk.dev/logo-dark.svg">
</picture>
</p>

<p align="center">

[![Discord](https://img.shields.io/discord/1198932605740003388?logo=discord&logoColor=white)](https://discord.gg/gQ7wqpvT5X)

</p>

<p align="center">
<a href="https://formwerk.dev">📚 Documentation website</a>
</p>

# Formwerk

Formwerk is a Vue.js framework that simplifies forms by providing a comprehensive suite of composables for building accessible, high-quality, and scalable form components.

Unlike other libraries, Formwerk deliberately excludes UI components, recognizing that design needs vary across projects. Instead, it provides a rock-solid foundation of accessibility, validation, state management, and interaction patterns that just work with your custom styling. This separation allows you to maintain complete creative control while ensuring your forms meet the highest standards of functionality and user experience.

With Formwerk as your foundation, you get high-quality form capabilities without compromising on flexibility. Whether you're creating a design system or standalone application, Formwerk handles the intricate details of forms, empowering you to create forms that are both beautiful and delightful.

## Contributing

You can contribute to Formwerk by reporting bugs, suggesting features, or submitting code changes. If you wish to submit code changes, please first discuss the change you wish to make via [GitHub issues](https://github.com/formwerkjs/formwerk/issues), [Discord](https://discord.gg/gQ7wqpvT5X), or other method.

You can visit the [contributing guide](./CONTRIBUTING.md) for more information on how to contribute to Formwerk and how to get started.

## Credits

Formwerk takes great inspiration from multiple projects in the ecosystem, most notably:

- [React Aria](https://react-spectrum.adobe.com/)
- [VeeValidate](https://vee-validate.logaretm.com/)
- [Radix UI](https://www.radix-ui.com/)

## License

Formwerk is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

0 comments on commit 55565a9

Please sign in to comment.