@moser-inc/moser-labs-react 1.16.5 → 2.0.0

package/README.md

@@ -10,6 +10,35 @@ npm i primereact @moser-inc/moser-labs-react
 
 ## Usage
 
+### Setup
+
+Wrap your application with the `LabsProvider` component to provide the app name, theme and favicon urls, and other potential configuration:
+
+```tsx
+// App.tsx
+import { LabsProvider } from '@moser-inc/moser-labs-react';
+
+const FAVICONS = {
+  dark: 'favicon-dark.svg',
+  light: 'favicon-light.svg',
+};
+
+const THEMES = {
+  dark: 'theme-dark.css',
+  light: 'theme-light.css',
+};
+
+const App = () => {
+  return (
+    <LabsProvider appName="My App" favicons={FAVICONS} themes={THEMES}>
+      {/* Your app components */}
+    </LabsProvider>
+  );
+};
+```
+
+### Styles
+
 Either load all component styles in your entry point, which may include unused styles:
 
 ```tsx