Update README.md to provide a comprehensive overview of The Order monorepo, including repository structure, quickstart guide, development workflow, and contribution guidelines.
This commit is contained in:
21
packages/workflows/README.md
Normal file
21
packages/workflows/README.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# @the-order/workflows
|
||||
|
||||
Temporal/Step Functions workflow definitions for The Order.
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
import { intakeWorkflow, reviewWorkflow } from '@the-order/workflows';
|
||||
|
||||
const result = await intakeWorkflow({
|
||||
documentId: 'doc-123',
|
||||
fileUrl: 'https://...',
|
||||
userId: 'user-123',
|
||||
});
|
||||
```
|
||||
|
||||
## Workflows
|
||||
|
||||
- `intakeWorkflow` - Document intake and processing
|
||||
- `reviewWorkflow` - Document review and approval
|
||||
|
||||
Reference in New Issue
Block a user