Skip to content

Commit 6909c38

Browse files
Copilotdev31sanghvi
andcommitted
Fix API usage examples for local development
Co-authored-by: dev31sanghvi <[email protected]>
1 parent 6d6f82b commit 6909c38

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

EXAMPLES.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,19 @@ copybuffer list
167167
### Using Copybuffer in Node.js Applications
168168

169169
```typescript
170+
// If installed globally via npm link or published to npm:
170171
import {
171172
clipboardMonitor,
172173
searchManager,
173174
storageManager,
174175
configManager
175176
} from 'copybuffer';
176177

178+
// For local development, import from the built files:
179+
// import { clipboardMonitor, searchManager, storageManager, configManager } from './dist/exports';
180+
// Or from source (requires TypeScript):
181+
// import { clipboardMonitor, searchManager, storageManager, configManager } from './src/exports';
182+
177183
// Start monitoring
178184
clipboardMonitor.start();
179185

@@ -202,7 +208,8 @@ clipboardMonitor.stop();
202208
### Custom Clipboard Processing
203209

204210
```typescript
205-
import { storageManager, ClipboardEntry } from 'copybuffer';
211+
// For local development:
212+
import { storageManager, ClipboardEntry } from './dist/exports';
206213

207214
// Load history
208215
const history = storageManager.loadHistory();

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,11 +243,15 @@ npm run format
243243

244244
## API Usage
245245

246-
You can also use Copybuffer programmatically:
246+
You can also use Copybuffer programmatically in your Node.js applications:
247247

248248
```typescript
249+
// After installing globally with npm link:
249250
import { clipboardMonitor, searchManager, storageManager } from 'copybuffer';
250251

252+
// For local development, import from the built files:
253+
// import { clipboardMonitor, searchManager, storageManager } from './dist/exports';
254+
251255
// Start monitoring
252256
clipboardMonitor.start();
253257

@@ -261,6 +265,8 @@ const recent = searchManager.getRecent(20);
261265
const history = storageManager.loadHistory();
262266
```
263267

268+
See [EXAMPLES.md](EXAMPLES.md) for more detailed usage examples.
269+
264270
## Troubleshooting
265271

266272
### Clipboard monitoring not working

0 commit comments

Comments
 (0)