coracle/vthumbs
2
1
Fork 1
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Improve README with clear API documentation and examples #4

New Issue
Open
opened 2026-04-15 18:40:05 +00:00 by priyanshu_bharti · 1 comment
priyanshu_bharti commented 2026-04-15 18:40:05 +00:00
Contributor
Copy Link
Copy Source

Problem

The current README is quite minimal and lacks proper API documentation.

Suggested Improvements

  • Add a clear API Reference section
  • Show example requests using curl
  • Document all supported query parameters (url, time, etc.)
  • Add example responses (success + error cases)
  • Mention how to run locally and with Docker

Why it matters

Better documentation helps developers integrate this service quickly.

### Problem The current README is quite minimal and lacks proper API documentation. ### Suggested Improvements - Add a clear **API Reference** section - Show example requests using `curl` - Document all supported query parameters (`url`, `time`, etc.) - Add example responses (success + error cases) - Mention how to run locally and with Docker ### Why it matters Better documentation helps developers integrate this service quickly.
priyanshu_bharti commented 2026-04-15 18:41:05 +00:00
Author
Contributor
Copy Link
Copy Source

hii @hodlbod
can i take up this issues

hii @hodlbod can i take up this issues
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
hodlbod (hodlbod)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: coracle/vthumbs#4
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?