Skip to content

Commit

Permalink
docs(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joaopalopes24 committed May 23, 2024
1 parent bf2a33d commit 3a50e5f
Showing 1 changed file with 35 additions and 4 deletions.
39 changes: 35 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,40 @@
# WireUi Documentation
<h2 style="display: flex; align-items: center; justify-content: center;">
<img src="https://wireui.dev/wireui/wireui-circle.png" height="100">
<p style="margin: 0px 16px;">WireUi Docs</p>
</h2>

Page for [WireUi](https://github.com/wireui/wireui) documentation.
<p align="center">
<a href="https://github.com/wireui/docs/actions">
<img src="https://github.com/wireui/docs/actions/workflows/tests.yml/badge.svg?branch=main" alt="Tests">
</a>

Visit at: [Documentation](https://wireui.dev)
<a href="https://x.com/Wire_Ui">
<img alt="Twitter" src="https://img.shields.io/twitter/url?url=https://x.com/Wire_Ui">
</a>
</p>

## Contribution
### πŸš€ Introduction

This documentation only refers to the new version of WireUi. If you want changes to the version 1 documentation, open an Issue and let us know what needs to be changed.

### πŸ“š Documentation

Documentation for WireUi can be found on the [WireUi website](https://wireui.dev).

### πŸ”§ Contributing

Thank you for considering contributing to WireUi Docs! The contribution guide can be found in the [WireUi documentation](https://wireui.dev/customize/contribution-guide).

### πŸ“£ Follow the WireUi

Stay informed about WireUI, follow [@Wire_Ui](https://x.com/Wire_Ui) on Twitter and [WireUi](https://www.linkedin.com/company/wireui) on LinkedIn.

There will you see all the latest news about features, ideas, discussions and more...

### πŸ’‘ Philosophy

WireUI is and will always be FREE to anyone who would like to use it. This project is created by [Pedro Oliveira](https://github.com/PH7-Jack), and it is maintained by the author and your team with the help of the community. All contributions are welcome!

### πŸ“ License

WireUi is open-sourced software licensed under the [MIT license](LICENSE.md).

0 comments on commit 3a50e5f

Please sign in to comment.