Skip to content

Commit

Permalink
docs: update readme clarifying scope of project
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Feb 5, 2025
1 parent 40d7d25 commit cad7350
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,25 @@

## Shared UI Components with HOT Theming

This repository contains HOT themed UI components to reduce code duplication
and simplify the lives of developers needing to prototype and develop well
designed web applications quickly.
This repository contains HOT themed UI components, with three goals:

1. Reduced code duplication across HOT tools (we repeat a lot!)
2. Simplified developer experience to create a HOT app.
3. Reasonably consistent theming and style across tools.

They are available as
[Web Components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components)
and has first-class React support.
and have first-class React support.

The main goal of this project is not to re-invent the wheel, or add an extra burden
of development and maintenance.
of development and maintenance. It should include a minimal number of components:

- Header, including auth flows (OSM, Google) and login info.
- Sidebar with links to extra resources.
- Footer with links.
- File upload component (including dropzone).
- Date picker component.
- Workflow stepper component.

## Quick start

Expand Down

0 comments on commit cad7350

Please sign in to comment.