Skip to content

docs: Rewrite project README - #45

Merged
wklken merged 1 commit into
masterfrom
codex/rewrite-readme-docs
Jul 5, 2026
Merged

wklken merged 1 commit into
masterfrom
codex/rewrite-readme-docs

Conversation

@wklken

@wklken wklken commented Jul 5, 2026

Copy link
Copy Markdown
Owner

Summary

  • Rewrote README.md as a concise current project landing page for github.com/wklken/gorequest.
  • Moved detailed request examples into docs/usage.md.
  • Removed stale README status, contribution, co-maintainer, and legacy contributor-table content while keeping upstream attribution.

Verification

  • git fetch origin master: fetched latest master before creating the worktree.
  • git diff --check -- README.md docs/usage.md: passed.
  • test -f docs/usage.md && test -f LICENSE && test -f Makefile: passed.
  • rg -n "Go Walker|Drone|Travis|co-maintainer|Contributing to GoRequest|parnurzeal at|wklken at|gorequst|exmaple|ioutil|github\\.com/parnurzeal/gorequest/\\.\\.\\.|AGENTS\\.md" README.md docs/usage.md: no matches.
  • Go tests not run because this PR only changes markdown documentation; AGENTS.md says markdown-only changes do not need make lint or make test.

Review

  • Reviewed with agent-skills:code-review-and-quality for correctness, readability, scope, and stale legacy content.
  • Required fixes made before commit: corrected the Timeouts example to use real exported fields and removed links to stale/internal docs from the public README.

Why this change was needed:
This fork is now maintained independently from the abandoned upstream project, so the README should present github.com/wklken/gorequest as the current project instead of preserving the old upstream front page.

What changed:
- Rewrote README.md as a concise project overview with current install, feature, usage, development, lineage, and license sections
- Moved detailed request examples into docs/usage.md
- Removed stale legacy status, contribution, co-maintainer, and contributor-table content from the README

Problem solved:
Users now get a current project landing page while detailed usage examples remain available in a separate maintained document.
@cursor

cursor Bot commented Jul 5, 2026

Copy link
Copy Markdown

Bugbot is not enabled for this team, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@wklken
wklken merged commit cb492c0 into master Jul 5, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant