set up jsrepo, readme, license

This commit is contained in:
David Haz
2025-07-09 10:15:05 +03:00
parent 8b35b43b08
commit ad6015691d
8 changed files with 2421 additions and 5 deletions

View File

@@ -1,3 +1,73 @@
# vue-bits
<div align="center">
<br>
<br>
<picture>
<source media="(prefers-color-scheme: light)" srcset="src/assets/logos/vuebits-gh-black.svg">
<source media="(prefers-color-scheme: dark)" srcset="src/assets/logos/vuebits-gh-white.svg">
<img src="src/assets/logos/vuebits-gh-black.svg" alt="vue-bits logo" width="1000">
</picture>
<br>
<br>
</div>
WIP
<div align="center">
The largest & most creative library of animated Vue components.
</div>
<br />
<div align="center">
<a href="https://github.com/davidhdev/vue-bits/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/davidhdev/vue-bits"></a>
<a href="https://github.com/davidhdev/vue-bits/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/badge/License-MIT+Commons_Clause-green"></a>
</div>
## Documentation
Go to [vuebits.dev](https://vuebits.dev/) to view the documentation.
## About
Vue Bits is a large collection of animated Vue components made to spice up your web creations. We've got animations, components, backgrounds, and awesome stuff that you won't be able to find anywhere else - all free for you to use! These components are all enhanced with customization options as props, to make it easy for you to get exactly what you need.
## Key Features
- 40+ total components (text animations, animations, components, backgrounds), growing every week
- All components have with minimal dependencies, and are highly customizable through props
- Designed to integrate seamlessly with any modern Vue project
## CLI (<a href="https://jsrepo.dev"><img src="https://jsrepo.dev/badges/jsrepo.svg" width="50" alt="jsrepo"></a>)
Vue Bits uses [jsrepo](https://jsrepo.dev) for installing components via CLI. </br>
The setup steps can be found on each component's page in the [documentation](https://vuebits.dev/).
## How To Contribute?
Contributions are welcome! Check the [Open Issues](https://github.com/DavidHDev/vue-bits/issues) to see how you can help or submit ideas using the [Feature Request template](https://github.com/DavidHDev/vue-bits/issues/new?template=2-feature-request.yml).</br>
Please review the [Contribution Guide](https://github.com/DavidHDev/vue-bits/blob/main/CONTRIBUTING.md) and follow our standards. Thanks for your time!
## Contributors
<a href="https://github.com/davidhdev/vue-bits/graphs/contributors">
<img src="https://contrib.rocks/image?repo=davidhdev/vue-bits" />
</a>
## Maintainers
[David Haz](https://github.com/DavidHDev)
## Stats
![Alt](https://repobeats.axiom.co/api/embed/02689c621a09cc5b492ccc1b4bb2f764e32500b7.svg "Repobeats analytics image")
## Sponsorship
You can help support the project by using the Sponsor button on the page - please note that any donations received will go strictly towards paying hosting costs, nothing else.
## Credit
Vue Bits may sometimes take inspiration from publicly available code examples online. These examples are rewritten as full-fledged, customizable, and reusable components. If you recognize your work here, just request credit and it will be granted.
## License
Licensed under the [MIT + Commons Clause license](https://github.com/davidhdev/vue-bits/blob/main/LICENSE.md).