@clickhouse/click-ui 0.0.17 → 0.0.19

package/README.md

@@ -1,11 +1,44 @@
 # Click UI
 The home of the ClickHouse design system and component library. Click UI is in very early development and subject to change, we do not recommend using it for production purposes.
 
-## Get started 🚀
+### Using Click UI in an external app
+Click UI has been tested in NextJS, Gatsby, and Vite. If you run into problems using it in your app, please create an issue and our team will try to answer.
+1. Navigate to your app's route and run
+   `npm i @clickhouse/click-ui`
+   or
+   `yarn add @clickhouse/click-ui`
+2. Make sure to wrap your application in the Click UI `ThemeProvider`, without doing this, you may run into issues with styled-components. Once thats done, you'll be able to import the individual components that you want to use on each page. Here's an example an `App.tsx` in NextJS.
+
+```
+import { Switch, Text, ThemeName, ThemeProvider, Title } from '@clickhouse/click-ui'
+
+function App() {
+  const [theme, setTheme] = useState<ThemeName>('dark')
+
+  const toggleTheme = () => {
+    theme === 'dark' ? setTheme('light') : setTheme('dark')
+  }
+
+  return (
+    <ThemeProvider theme={theme}>
+      <Switch checked={theme === 'dark'} onClick={() => toggleTheme() } />
+
+      <Title type='h1'>Click UI Example</Title>
+      <Text>Welcome to Click UI. Get started here.</Text>
+    </ThemeProvider>
+  )
+}
+
+export default App
+```
+    
+
+
+### To develop this library locally 🚀
 1. Clone this repo, cd into the `click-ui` directory
-2. To install dependencies, run `yarn` 
-3. To build the latest styles, run `yarn generate-tokens`
-4. To run ClickUI locally, run `yarn dev` and navigate to https://localhost:5173
-5. To run Storybook locally, run `yarn storybook` and navigate to https://localhost:6006
+2. To install dependencies, run `npm i` 
+3. To build the latest styles, run `npm run generate-tokens`
+4. To run ClickUI locally, run `npm run dev` and navigate to https://localhost:5173
+5. To run Storybook locally, run `npm run storybook` and navigate to https://localhost:6006
 
 Enjoy!