ci: docs

README.md

@@ -0,0 +1 @@
+packages/theme/README.md

packages/docs/src/stories/Introduction.stories.mdx

@@ -1,4 +1,4 @@
-import Readme from '../../../../README.md'
+import Readme from '@marcus-rise/react-theme/README.md'
 import {Canvas, Meta} from '@storybook/addon-docs';
 import {Description} from '@storybook/addon-docs/blocks';
 import {App} from "../components/simple-example.component";

packages/theme/README.md

@@ -0,0 +1,79 @@
+# React theme
+
+Handle system color scheme and user preferences.
+
+## Install
+
+using `npm`
+
+```bash
+npm install @marcus-rise/react-theme
+```
+
+or using `yarn`
+
+```bash
+yarn add @marcus-rise/react-theme
+```
+
+## Usage
+
+First of all, we need to initialize `ThemeProvider` context, and after this we can get access with
+hook `useTheme`.
+
+```tsx
+import {ThemeProvider, useTheme} from "@marcus-rise/react-theme";
+
+const ThemeToggle = () => {
+  const {isDarkTheme, preferences, toggleTheme} = useTheme();
+
+  return (
+    <>
+      <button onClick={toggleTheme}>toggle</button>
+      <br/>
+      <span>preferences: {preferences}</span>
+      <br/>
+      <span>isDarkTheme: {isDarkTheme ? "yes" : "no"}</span>
+    </>
+  )
+}
+
+const App = () => (
+  <ThemeProvider>
+    <ThemeToggle/>
+  </ThemeProvider>
+)
+```
+
+## API
+
+### Context provider `ThemeProvider`
+
+To set custom localStorage key set `preferencesStorageKey` property for user preferences
+
+```tsx
+<ThemeProvider preferencesStorageKey={"OPTIONAL_APP_THEME_STORAGE_KEY"}>
+```
+
+### Hook `useTheme`
+
+- `isDarkTheme` is a`boolean` what color scheme is selected, basing on user preferences and system
+  settings
+- `preferences` is a `string` form `enum`
+
+```ts
+enum ThemePreference {
+  DARK = "dark",
+  LIGHT = "light",
+  SYSTEM = "system",
+}
+```
+
+you can import this enum directly
+
+```ts
+import {ThemeProvider} from "@marcus-rise/react-theme";
+```
+
+- `toggleTheme` is a `function`, that toggle preferences from `system` -> `light` -> `dark`
+