markmead/hyperui

Improve HyperUI README

Closed this issue · 1 comments

ToobaJamal commented

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

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.

  • 😄1