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:
22
packages/storage/README.md
Normal file
22
packages/storage/README.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# @the-order/storage
|
||||
|
||||
Storage abstraction for S3/GCS with WORM mode support.
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
import { StorageClient, WORMStorage } from '@the-order/storage';
|
||||
|
||||
const storage = new StorageClient(config);
|
||||
const wormStorage = new WORMStorage(config);
|
||||
|
||||
await storage.upload({ key: 'file.txt', content: 'Hello' });
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- S3 and GCS support
|
||||
- WORM (Write Once Read Many) mode
|
||||
- Presigned URL generation
|
||||
- Object lifecycle management
|
||||
|
||||
Reference in New Issue
Block a user