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

Improve README with clear API reference, examples, and setup guides #6

Closed
priyanshu_bharti wants to merge 1 commits from priyanshu_bharti/vthumbs:docs/readme-pr-clean into master
pull from: priyanshu_bharti/vthumbs:docs/readme-pr-clean
merge into: coracle:master
Conversation 1 Commits 1 Files Changed 1
+109 -24
priyanshu_bharti commented 2026-04-15 20:25:41 +00:00
Contributor
Copy Link
Copy Source

Summary

This PR improves the project documentation by rewriting the README to make it clearer, more complete, and developer-friendly.

What Changed

  • Added a clearer project overview and feature list
  • Expanded requirements for local development
  • Added Quick Start steps for running locally
  • Improved Docker setup instructions
  • Added an API Reference section for GET /thumbnail?url=VIDEO_URL
  • Documented supported query parameters
  • Added success and error response documentation
  • Added practical curl examples for success and failure cases
  • Added a clear license section

Why

The previous README was minimal and did not provide enough API details or examples for easy integration.

This update addresses Issue #4 by making onboarding and API usage straightforward for developers.

Testing

  • Verified Markdown structure and formatting
  • Checked that all requested sections are present
  • Confirmed command examples and endpoint references are consistent with current implementation

Related

## Summary This PR improves the project documentation by rewriting the README to make it clearer, more complete, and developer-friendly. ## What Changed - Added a clearer project overview and feature list - Expanded requirements for local development - Added Quick Start steps for running locally - Improved Docker setup instructions - Added an API Reference section for `GET /thumbnail?url=VIDEO_URL` - Documented supported query parameters - Added success and error response documentation - Added practical `curl` examples for success and failure cases - Added a clear license section ## Why The previous README was minimal and did not provide enough API details or examples for easy integration. This update addresses Issue #4 by making onboarding and API usage straightforward for developers. ## Testing - Verified Markdown structure and formatting - Checked that all requested sections are present - Confirmed command examples and endpoint references are consistent with current implementation ## Related - Closes #4
priyanshu_bharti added 1 commit 2026-04-15 20:25:42 +00:00
docs: improve README with API documentation and examples c9a9c92a87
hodlbod commented 2026-04-15 21:21:26 +00:00
Owner
Copy Link
Copy Source

Less is more, I don't think this adds anything of value. A note about response format could be ok, but that would be a one line change.

Less is more, I don't think this adds anything of value. A note about response format could be ok, but that would be a one line change.
hodlbod closed this pull request 2026-04-15 21:21:30 +00:00

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
hodlbod (hodlbod)
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: coracle/vthumbs#6
Delete Branch "priyanshu_bharti/vthumbs:docs/readme-pr-clean"

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?