Update README and license docs

2026-05-05 19:53:54 +00:00
parent 5ff0d80e7e
commit fb56c7f3a4
2 changed files with 114 additions and 1 deletions
@@ -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,95 @@
 # @smarthome.exchange/agents

-Editable reference agent definitions for smarthome.exchange installs.
+🤖 Editable reference agent definitions for smarthome.exchange installs.
+
+This package ships the starter agent roster used by the hub and demo experiences. Agents are plain typed data: names, roles, glyphs, colors, modes, scopes, models, prompts, and enablement flags. Runtime execution stays in `@smarthome.exchange/hub`; this package is the clean place to start, inspect, copy, or customize agent personalities.
+
+## 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/agents
+```
+
+## Usage
+
+```ts
+import { getReferenceAgentById, referenceAgents } from '@smarthome.exchange/agents';
+
+for (const agent of referenceAgents) {
+  console.log(`${agent.name}: ${agent.role} (${agent.mode})`);
+}
+
+const comfortAgent = getReferenceAgentById('comfort');
+console.log(comfortAgent?.scopes);
+```
+
+## Starter Agents
+
+| Agent | Mode | Role | Default scopes |
+| --- | --- | --- | --- |
+| `comfort` | `auto` | Climate, light, ambience | Climate, light, and device reads/writes. |
+| `sentinel` | `ask` | Locks, cameras, presence | Lock, camera, alarm, and device scopes. |
+| `watt` | `ask` | Energy, solar, EV, appliances | Energy, climate, and device scopes. |
+| `dawn` | `auto` | Wake, wind-down, daily ritual | Light and device scopes. |
+| `echo` | `suggest` | Audio, media, follow-me | Device reads/writes. |
+| `steward` | `ask` | Errands, deliveries, household ops | `*.read` and approval writing. |
+
+## Public API
+
+| Export | Purpose |
+| --- | --- |
+| `referenceAgents` | Array of `IAgentDefinition` objects ready for registration in a hub or local profile. |
+| `getReferenceAgentById(agentId)` | Returns the matching reference agent or `undefined`. |
+
+## Customizing Agents
+
+Agents are intentionally copyable. A home can start with the reference roster, then override prompts, scopes, models, colors, or modes in local config without changing hub execution code.
+
+```ts
+import { referenceAgents } from '@smarthome.exchange/agents';
+
+const localAgents = referenceAgents.map((agentArg) => {
+  if (agentArg.id !== 'sentinel') {
+    return agentArg;
+  }
+
+  return {
+    ...agentArg,
+    mode: 'ask' as const,
+    systemPrompt: `${agentArg.systemPrompt} Always explain security-sensitive actions before requesting approval.`,
+  };
+});
+```
+
+## Scripts
+
+```bash
+pnpm test
+pnpm build
+pnpm buildDocs
+```
+
+## 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.