diff --git a/libs/base-ui/README.md b/libs/base-ui/README.md index 86c1cdbfc9..f9e97ee170 100644 --- a/libs/base-ui/README.md +++ b/libs/base-ui/README.md @@ -1 +1,23 @@ # base-ui + +A shared UI component library for Base web applications. + +## Components + +- **Button** - Reusable button component +- **Select** - Select dropdown component +- **Icon** - Icon component + +## Hooks + +- `useClickAway` - Hook to detect clicks outside an element +- `useSprig` - Hook for Sprig integration + +## Contexts + +- `Analytics` - Analytics context provider +- `Experiments` - Experiment context provider + +## Utils + +Utility functions for logging, string manipulation, and event sanitization.