diff --git a/README.md b/README.md index 40ef9f4..75bb91d 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,37 @@ -# Odigos UI Components +# Odigos UI Utils ## Installation Using **npm**: ```shell -npm i @odigos/ui-components +npm i @odigos/ui-utils ``` Using **yarn**: ```shell -yarn add @odigos/ui-components +yarn add @odigos/ui-utils ``` ## Usage -Wrap your app with the theme provider: +Import a util, and call it with it's params: ```tsx -import { Theme } from '@odigos/ui-components' - -const AppProviders = () => { - const darkMode = true - - return ( - - - - ) -} -``` - -Import a component, and call it with it's props: - -```tsx -import { Button, PlusIcon } from '@odigos/ui-components' +import { useKeyDown } from '@odigos/ui-utils' const App = () => { - const handleClick = () => { - console.log('clicked') - } - - return ( - + useKeyDown( + { + key: 'Enter', + active: true, + }, + () => { + console.log('key pressed') + } ) + + return
hi mom
} ```