ssovee-os-web-ui 0.1.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SSOVEE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,157 @@
+# ssovee-os-web-ui
+
+A standalone React UI component library that packages the shared, reusable components from this repository into a publishable npm package.
+
+## Features
+
+- Shared UI component exports for multiple applications
+- TypeScript-friendly component interfaces
+- Tree-shakeable package build output
+- SemVer-friendly publish workflow
+
+## Installation
+
+Install the library in your app:
+
+```bash
+npm install ssovee-os-web-ui
+```
+
+If your app does not already include React and React DOM, install them as well:
+
+```bash
+npm install react react-dom
+```
+
+This library uses Tailwind CSS. Install Tailwind CSS in the consuming application and follow the configuration below so Tailwind generates the library's classes.
+
+## Tailwind CSS setup
+
+Import the supplied base theme once from your application's global CSS file:
+
+```css
+@import "ssovee-os-web-ui/theme.css";
+```
+
+For Tailwind v3, add the library build output to `content` and use the supplied preset:
+
+```js
+import ssoveePreset from "ssovee-os-web-ui/tailwind-preset";
+
+export default {
+  content: [
+    "./src/**/*.{js,ts,jsx,tsx}",
+    "./node_modules/ssovee-os-web-ui/dist/**/*.{js,mjs,cjs}",
+  ],
+  presets: [ssoveePreset],
+};
+```
+
+For Tailwind v4, add the package as a source in your global CSS file and load a config containing the same preset:
+
+```css
+@import "tailwindcss";
+@source "../node_modules/ssovee-os-web-ui/dist";
+@config "../tailwind.config.js";
+@import "ssovee-os-web-ui/theme.css";
+```
+
+The preset includes the library's semantic colors (`primary`, `secondary`, `surface-*`, `brand-color`, `border-1`, and `muted`). Override the `--ssovee-*` CSS variables in your application to customize the theme.
+
+## Usage
+
+```tsx
+import { Button, Input, Card } from "ssovee-os-web-ui";
+
+export function Example() {
+  return (
+    <Card>
+      <Input placeholder="Search" />
+      <Button variant="primary">Save</Button>
+    </Card>
+  );
+}
+```
+
+## Available exports
+
+The library publishes the following shared UI components from the package entry point:
+
+- `Button`
+- `Input`
+- `TextArea`
+- `Select`
+- `Checkbox`
+- `Toggle`
+- `Dropdown`
+- `Loading`
+- `Toast`
+- `Alert`
+- `Modal`
+- `Card`
+- `Badge`
+- `Avatar`
+- `Divider`
+- `Tooltip`
+- `SearchInput`
+- `FileUpload`
+- `Progress`
+- `Pagination`
+- `Radio`
+- `Accordion`
+- `Tabs`
+- `Typography`
+- `ImageWithPlaceholder`
+- `Table` and its table subcomponents
+- `useShortcutFormatter`
+- `cn`
+
+## Package structure
+
+```text
+src/
+  components/
+  hooks/
+  utils/
+  index.ts
+```
+
+## Build
+
+```bash
+npm install
+npm run build
+```
+
+## Hook and utility usage
+
+```tsx
+import { cn, useShortcutFormatter } from "ssovee-os-web-ui";
+
+const { formatKeys } = useShortcutFormatter();
+const className = cn("button", isActive && "button-active");
+const shortcutLabel = formatKeys(["ctrl", "k"]);
+```
+
+## Versioning and release
+
+Use semantic versioning for releases:
+
+```bash
+npm run release:patch
+npm run release:minor
+npm run release:major
+```
+
+Then publish:
+
+```bash
+npm login
+npm publish --access public
+```
+
+## CI publish workflow
+
+This repo is prepared for automated release publishing through GitHub Actions using the `NODE_AUTH_TOKEN` secret.
+
+Before publishing, add an npm automation token with publish permission as the repository's `NPM_TOKEN` Actions secret. Create a version commit and matching tag (for example, `v0.1.1`), then push the tag to trigger the workflow.