Skip to content

Commit daf970d

Browse files
committed
docs: update README with enhanced usage examples including env vars and error handling
1 parent 00d9fd0 commit daf970d

1 file changed

Lines changed: 27 additions & 3 deletions

File tree

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,33 @@ PROJECT_ID=your_project_id_here
6060
```typescript
6161
import { mdToProject, projectToMd } from 'github-projects-md-sync';
6262

63-
await mdToProject(projectId, githubToken, './markdown-files');
64-
await projectToMd(projectId, githubToken, './output-dir');
65-
await projectToMd(projectId, githubToken);
63+
// Get environment variables
64+
const projectId = process.env.PROJECT_ID;
65+
const token = process.env.GITHUB_TOKEN;
66+
67+
// Sync markdown files to GitHub Project
68+
const { result: mdResult, logs: mdLogs } = await mdToProject(projectId, token, './markdown-files');
69+
70+
// Export GitHub Project items to markdown files
71+
const { result: projectResult, logs: projectLogs } = await projectToMd(projectId, token, './output-dir');
72+
73+
// Export to default directory
74+
const { result: defaultResult, logs: defaultLogs } = await projectToMd(projectId, token);
75+
76+
// Handle logs
77+
if (result.success) {
78+
console.log(`Project items synced to markdown files successfully in ${result.outputDir}!`);
79+
console.log(`Created/updated ${result.files.length} files.`);
80+
} else {
81+
console.error("Failed to sync project to markdown.");
82+
if (result.errors.length > 0) {
83+
console.error("\n--- Errors ---");
84+
result.errors.forEach(error => {
85+
console.error(`[${error.level.toUpperCase()}] ${error.message}`, ...error.args);
86+
});
87+
console.error("--------------\n");
88+
}
89+
}
6690
```
6791

6892
### Examples

0 commit comments

Comments
 (0)