search

markmead / hyperui

Free Tailwind CSS components for application UI, ecommerce and marketing with support for dark mode, RTL and Alpine JS 🚀
https://hyperui.dev
MIT License
8.89k stars 344 forks source link

Improve HyperUI README #394

Closed ToobaJamal closed 8 months ago

ToobaJamal commented 9 months ago

The current README gives an overview of HyperUI but it lacks necessary details like:

  1. Getting started: Describes how to start using HyperUI in a project. Since it doesn't require installation, it section is going to be interesting.
  2. Usage: How to use HyperUI components including use cases, screenshots/ GIFs.
  3. Components: List of components available in HyperUI including links.
  4. Contributing: How developers can contribute to this project.
  5. Licence.

I would love to work on this if you approve.

markmead commented 9 months ago

Hey @ToobaJamal README updates sound good!

There's a blog post on the website that details how you can contribute to the project, please link to that.