Skip to content

Improve TradeMe repository README - #36

Draft
mrfloris wants to merge 1 commit into
Zrips:masterfrom
mrfdev:agent/improve-readme
Draft

Improve TradeMe repository README#36
mrfloris wants to merge 1 commit into
Zrips:masterfrom
mrfdev:agent/improve-readme

Conversation

@mrfloris

@mrfloris mrfloris commented Aug 7, 2026

Copy link
Copy Markdown

Summary

  • replace the one-line README with a concise introduction to TradeMe
  • clarify that this repository currently serves as the public issue and feature-request tracker and does not contain source or downloads
  • link the official TradeMe resource, CMILib dependency, issue tracker, and Zrips website
  • add practical bug-reporting guidance and direct sensitive exploit reports to private contact

Why

The repository is actively used for TradeMe reports, but its current README does not explain the plugin, the repository's observed role, its CMILib requirement, or where users should obtain documentation and downloads.

The README intentionally leaves changing compatibility ranges, commands, permissions, and API details on the official resource page rather than duplicating information that could drift.

Validation

  • reviewed every product and dependency claim against the repository's contents and issue usage, maintainer-authored SpigotMC information, and the official CMILib resource
  • confirmed that the upstream branch still contains only .gitignore and the original one-line README
  • ran git diff --check
  • changed only README.md; no plugin source, build, or runtime behavior is affected

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