Update README and license docs
This commit is contained in:
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Task Venture Capital GmbH
|
||||
|
||||
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.
|
||||
@@ -1,3 +1,98 @@
|
||||
# @smarthome.exchange/catalog
|
||||
|
||||
Web component catalog for smarthome.exchange landing, console, dashboard, and primitive UI components.
|
||||
🎛️ Web component catalog for the smarthome.exchange product UI.
|
||||
|
||||
This package contains the Dees/Lit component layer: design tokens, primitive controls, the landing page, and the console shell. It is intentionally UI-first and mostly stateless; live home state should come from `@smarthome.exchange/api` and shared shapes from `@smarthome.exchange/interfaces`.
|
||||
|
||||
## Issue Reporting and Security
|
||||
|
||||
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pnpm add @smarthome.exchange/catalog
|
||||
```
|
||||
|
||||
## Use The Components
|
||||
|
||||
Importing the package registers the custom elements exported by the catalog:
|
||||
|
||||
```ts
|
||||
import '@smarthome.exchange/catalog';
|
||||
|
||||
document.body.innerHTML = `
|
||||
<shx-card heading="Living Room">
|
||||
<shx-badge kind="success" shape="pill">online</shx-badge>
|
||||
<shx-button kind="primary">Run evening scene</shx-button>
|
||||
</shx-card>
|
||||
`;
|
||||
```
|
||||
|
||||
Render the product surfaces directly:
|
||||
|
||||
```html
|
||||
<shx-landing-page></shx-landing-page>
|
||||
<shx-console-shell></shx-console-shell>
|
||||
```
|
||||
|
||||
## Public Surface
|
||||
|
||||
| Export | Purpose |
|
||||
| --- | --- |
|
||||
| `shxBaseStyles`, `shxElementStyles` | Shared design tokens and element base styles. |
|
||||
| `shx-badge` / `ShxBadge` | Status labels with variants, dot mode, and pill shape. |
|
||||
| `shx-button` / `ShxButton` | Product buttons with kind, size, and block layout options. |
|
||||
| `shx-card` / `ShxCard` | Content container with heading, action slot, flush mode, and elevated mode. |
|
||||
| `shx-icon` / `ShxIcon` | Icon wrapper for catalog/product iconography. |
|
||||
| `shx-console-shell` / `ShxConsoleShell` | Console surface for the local home runtime UI. |
|
||||
| `shx-landing-page` / `ShxLandingPage` | Marketing/developer landing page component. |
|
||||
|
||||
Additional demo data exports are available for catalog previews, including agents, devices, approvals, household data, rooms, blocks, and activity stream examples.
|
||||
|
||||
## Primitive Attributes
|
||||
|
||||
| Element | Useful attributes and slots |
|
||||
| --- | --- |
|
||||
| `shx-badge` | `kind`, `dot`, `shape="pill"`. |
|
||||
| `shx-button` | `kind`, `size`, `block`. |
|
||||
| `shx-card` | `heading`, `flush`, `elevated`, `slot="action"`. |
|
||||
|
||||
## Development Preview
|
||||
|
||||
The `html/` entry wires the catalog into `@design.estate/dees-wcctools` so components can be previewed locally by the surrounding build/watch tooling.
|
||||
|
||||
```bash
|
||||
pnpm build
|
||||
pnpm watch
|
||||
pnpm test
|
||||
```
|
||||
|
||||
`pnpm test` currently runs the build, which is the meaningful verification step for this web component package.
|
||||
|
||||
## Design Notes
|
||||
|
||||
- The package follows the established Dees component stack: `@design.estate/dees-element`, `dees-domtools`, and `dees-wcctools`.
|
||||
- Components are registered as custom elements and can be used from plain HTML, TypeScript, or higher-level app shells.
|
||||
- Demo data is for catalog previews. Durable domain types belong in `@smarthome.exchange/interfaces`.
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./license) file.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
||||
|
||||
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH\
|
||||
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
Reference in New Issue
Block a user