@commandkit/workflow 0.0.0-dev.20251108082950 → 0.0.0-dev.20251108124628

package/README.md

@@ -5,13 +5,66 @@ CommandKit plugin for [useworkflow.dev](https://useworkflow.dev).
 ## Installation
 
 ```bash
-npm install @commandkit/workflow
+npm install @commandkit/workflow workflow
 ```
 
 ## Usage
 
 ```typescript
+import { defineConfig } from 'commandkit/config';
 import { workflow } from '@commandkit/workflow';
+
+export default defineConfig({
+  plugins: [workflow()],
+});
+```
+
+Then, add workflow functions inside `src/workflows` directory.
+
+```typescript
+import { sleep } from 'workflow';
+import { useClient } from 'commandkit/hooks';
+
+export async function greetUserWorkflow(userId: string) {
+  'use workflow';
+
+  await greetUser(userId);
+
+  await sleep('5 seconds');
+
+  await greetUser(userId, true);
+
+  return { success: true };
+}
+
+async function greetUser(userId: string, again = false) {
+  'use step';
+
+  const client = useClient<true>();
+
+  const user = await client.users.fetch(userId);
+
+  const message = again ? 'Hello again!' : 'Hello!';
+
+  await user.send(message);
+}
+```
+
+Now, you can run the workflow using the `start` function in your commands (or other places).
+
+```typescript
+import { start } from 'workflow/api';
+import {greetUserWorkflow} from '@/workflows/greet';
+
+export const command: CommandData = {
+    name: 'greet',
+    description: 'Greet command',
+};
+
+export const chatInput: ChatInputCommand = async (ctx) => {
+    await ctx.interaction.reply("I'm gonna greet you :wink:");
+    await start(greetUserWorkflow, [ctx.interaction.user.id]);
+}
 ```
 
 ## Documentation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commandkit/workflow",
-  "version": "0.0.0-dev.20251108082950",
+  "version": "0.0.0-dev.20251108124628",
   "description": "CommandKit plugin for useworkflow.dev",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -39,8 +39,8 @@
   "devDependencies": {
     "typescript": "^5.8.3",
     "workflow": "^4.0.1-beta.12",
-    "commandkit": "1.2.0-dev.20251108082950",
-    "tsconfig": "0.0.0-dev.20251108082950"
+    "commandkit": "1.2.0-dev.20251108124628",
+    "tsconfig": "0.0.0-dev.20251108124628"
   },
   "dependencies": {
     "@hono/node-server": "^1.19.6",