@loopstack/meeting-notes-example-workflow 0.18.0-rc.0 → 0.18.1

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @loopstack/meeting-notes-example-workflow@0.18.0-rc.0 build
+> @loopstack/meeting-notes-example-workflow@0.18.1 build
 > nest build
 

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @loopstack/meeting-notes-example-workflow
 
+## 0.18.1
+
+### Patch Changes
+
+- [#36](https://github.com/loopstack-ai/loopstack/pull/36) [`1af9cd4`](https://github.com/loopstack-ai/loopstack/commit/1af9cd4edb37b60e3df677ba450ad22a936f447d) Thanks [@jakobklippel](https://github.com/jakobklippel)! - Add loopstack-module config and update readme files
+
+- Updated dependencies [[`1af9cd4`](https://github.com/loopstack-ai/loopstack/commit/1af9cd4edb37b60e3df677ba450ad22a936f447d)]:
+  - @loopstack/core-ui-module@0.18.1
+  - @loopstack/ai-module@0.18.1
+
+## 0.18.0
+
+### Minor Changes
+
+- [#13](https://github.com/loopstack-ai/loopstack/pull/13) [`13ab1a7`](https://github.com/loopstack-ai/loopstack/commit/13ab1a792a12bc46e0a21cf1ac038a7e69c566df) Thanks [@jakobklippel](https://github.com/jakobklippel)! - Added from external repository
+
+### Patch Changes
+
+- Updated dependencies [[`eea1b9f`](https://github.com/loopstack-ai/loopstack/commit/eea1b9ff10eaf8eda2a1bd4c2042148f964d5a39), [`e556176`](https://github.com/loopstack-ai/loopstack/commit/e5561769b365218f1ffdc890b887e7b607d06101), [`4ee0af1`](https://github.com/loopstack-ai/loopstack/commit/4ee0af1536e7802eb9d69a788c10184e3c5a7a11), [`3fd1db5`](https://github.com/loopstack-ai/loopstack/commit/3fd1db5d0de8ad26e3e22348f7f1593024a74273)]:
+  - @loopstack/ai-module@0.18.0
+  - @loopstack/core-ui-module@0.18.0
+  - @loopstack/core@0.18.0
+  - @loopstack/common@0.18.0
+
 ## 0.18.0-rc.0
 
 ### Minor Changes

package/README.md

@@ -20,82 +20,47 @@ This example is essential for developers building workflows that require human o
 
 ## Installation
 
-### Prerequisites
+You can add this module using the `loopstack` cli or via `npm`.
 
-Create a new Loopstack project if you haven't already:
+### a) Add Sources via `loopstack add` (recommended)
 
 ```bash
-npx create-loopstack-app my-project
-cd my-project
+loopstack add @loopstack/meeting-notes-example-workflow
 ```
 
-Start Environment
+This command copies the source files into your `src` directory.
 
-```bash
-cd my-project
-docker compose up -d
-```
+- It is a great way to explore the code to learn new concepts or add own customizations
+- It will set up the module for you, so you do not need to manually update your application
 
-### Add the Module
+### b) Install via `npm install`
 
 ```bash
-loopstack add @loopstack/meeting-notes-example-workflow
+npm install --save @loopstack/meeting-notes-example-workflow
 ```
 
-This copies the source files into your `src` directory.
+Use npm install if you want to use and maintain the module as node dependency.
 
-> Using the `loopstack add` command is a great way to explore the code to learn new concepts or add own customizations.
+- Use this, if you do not need to make changes to the code or want to review the source code.
 
 ## Setup
 
-### 1. Import the Module
+### 1. Configure API Key
 
-Add `MeetingNotesExampleModule` to your `default.module.ts` (included in the skeleton app) or to your own module:
+Set your OpenAI API key as an environment variable:
 
-```typescript
-import { Module } from '@nestjs/common';
-import { AiModule } from '@loopstack/ai-module';
-import { LoopCoreModule } from '@loopstack/core';
-import { CoreUiModule } from '@loopstack/core-ui-module';
-import { MeetingNotesExampleModule } from './@loopstack/meeting-notes-example-workflow';
-import { DefaultWorkspace } from './default.workspace';
-
-@Module({
-  imports: [LoopCoreModule, MeetingNotesExampleModule],
-  providers: [DefaultWorkspace],
-})
-export class DefaultModule {}
+```bash
+OPENAI_API_KEY=sk-...
 ```
 
-### 2. Register in Your Workspace
+### 2. Manual setup (optional)
 
-Add the workflow to your workspace class using the `@Workflow()` decorator:
+> This step is automatically done for you when using the `loopstack add` command.
 
-```typescript
-import { Injectable } from '@nestjs/common';
-import { BlockConfig, Workflow } from '@loopstack/common';
-import { WorkspaceBase } from '@loopstack/core';
-import { MeetingNotesWorkflow } from './@loopstack/meeting-notes-example-workflow';
-
-@Injectable()
-@BlockConfig({
-  config: {
-    title: 'My Workspace',
-    description: 'A workspace with the meeting notes example workflow',
-  },
-})
-export class MyWorkspace extends WorkspaceBase {
-  @Workflow() meetingNotesWorkflow: MeetingNotesWorkflow;
-}
-```
-
-### 3. Configure API Key
-
-Set your OpenAI API key as an environment variable:
+- Add `MeetingNotesExampleModule` to the imports of `default.module.ts` or any other custom module.
+- Inject the `MeetingNotesWorkflow` workflow to your workspace class using the `@Workflow()` decorator.
 
-```bash
-OPENAI_API_KEY=sk-...
-```
+See here for more information about working with [Modules](https://loopstack.ai/docs/building-with-loopstack/creating-a-module) and [Workspaces](https://loopstack.ai/docs/building-with-loopstack/creating-workspaces)
 
 ## How It Works
 

package/loopstack-module.json

@@ -0,0 +1,4 @@
+{
+  "module": "src/meeting-notes-example.module.ts",
+  "workflows": ["src/meeting-notes.workflow.ts"]
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@loopstack/meeting-notes-example-workflow",
   "displayName": "Loopstack Meeting Notes Example Worflow",
   "description": "A complete workflow demonstrating how to create a workflow in loopstack based on a meeting notes summary use case.",
-  "version": "0.18.0-rc.0",
+  "version": "0.18.1",
   "author": {
     "name": "Jakob Klippel",
     "url": "https://www.linkedin.com/in/jakob-klippel/"
@@ -30,10 +30,10 @@
     "watch": "nest build --watch"
   },
   "dependencies": {
-    "@loopstack/ai-module": "^0.18.0-rc.0",
-    "@loopstack/common": "^0.18.0-rc.1",
-    "@loopstack/core": "^0.18.0-rc.1",
-    "@loopstack/core-ui-module": "^0.18.0-rc.0",
+    "@loopstack/ai-module": "^0.18.1",
+    "@loopstack/common": "^0.18.0",
+    "@loopstack/core": "^0.18.0",
+    "@loopstack/core-ui-module": "^0.18.1",
     "@nestjs/common": "^11.1.12",
     "zod": "^4.3.5"
   },