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/test-utils/README.md
Normal file
21
packages/test-utils/README.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# @the-order/test-utils
|
||||
|
||||
Shared testing utilities for The Order monorepo.
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
import { createTestUser, createTestDocument, sleep } from '@the-order/test-utils';
|
||||
|
||||
const user = createTestUser({ email: 'custom@example.com' });
|
||||
const doc = createTestDocument({ title: 'My Document' });
|
||||
await sleep(1000);
|
||||
```
|
||||
|
||||
## Available Utilities
|
||||
|
||||
- `createTestUser()` - Create a test user object
|
||||
- `createTestDocument()` - Create a test document object
|
||||
- `sleep()` - Wait for a specified number of milliseconds
|
||||
- `createMockResponse()` - Create a mock fetch response
|
||||
|
||||
Reference in New Issue
Block a user