docs: clarify OpenResty LuaJIT runtime scope

[membphis]

Summary

• Clarify that OpenResty LuaJIT is the primary supported runtime and PUC Lua is not supported because qjson depends on LuaJIT FFI
• Update LuaRocks install guidance to target Lua 5.1 / LuaJIT explicitly
• Split build/install requirements from runtime requirements and keep stock LuaJIT lazy-proxy caveats discoverable

Test Plan

• git diff --check HEAD~1..HEAD
• rg -n "Primary supported runtime|Standard PUC Lua|luarocks --lua-version=5.1 install|Build/install requirements|Runtime requirements|LuaJIT compat-52 caveat|qjson.pairs|qjson.ipairs|qjson.len" README.md

Fixes #118

Summary by CodeRabbit

• Documentation
  • Clarified supported runtime requirements, explicitly designating OpenResty LuaJIT as the primary supported runtime and documenting PUC Lua incompatibility
  • Updated installation instructions and reorganized build-time vs runtime requirements
  • Enhanced API documentation for clarity on compatibility and available function options

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c5e2c818-6142-42d2-816d-a2def5eb2ae2

📥 Commits

Reviewing files that changed from the base of the PR and between 9b57605 and 5b4cd42.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

README documentation clarifies OpenResty LuaJIT as the primary supported runtime, updates the LuaRocks installation command to explicitly target Lua 5.1, separates build-time and runtime requirements, adjusts production deployment guidance, and refines lazy-table and compat-52 API documentation.

Changes

OpenResty LuaJIT Runtime Clarity and Installation Guidance

Layer / File(s)	Summary
Runtime support statement and installation instructions README.md	Introductory text now explicitly names OpenResty LuaJIT as the primary supported runtime and reaffirms lack of PUC Lua support due to FFI dependency. Installation section is rewritten with luarocks --lua-version=5.1 install lua-qjson and separates build/install-time dependencies from runtime requirements.
Deployment and runtime dependency guidance README.md	Builder-stage and production deployment sections adjusted to state the runtime stage should contain OpenResty LuaJIT (preferred) or LuaJIT while excluding Rust, and runtime dependency text updated to specify required OS-level shared libraries.
API documentation refinements for lazy tables and compat-52 README.md	qjson.encode documentation shifted from generic "drop-in replacement" to "cjson-compatible encode path for lazy proxies." LuaJIT compat-52 caveat rewritten to tie pairs/ipairs/# behavior to LUAJIT_ENABLE_LUA52COMPAT builds and direct stock LuaJIT users to alternative qjson.* functions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• api7/lua-qjson#92: Updates the "no Rust at runtime" production deployment section, directly building on the prior PR's addition of that same deployment guidance.

🚥 Pre-merge checks | ✅ 5 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
E2e Test Quality Review	⚠️ Warning	Actual commit has 415 files with 18,390 insertions, not docs-only. Scope mismatch between PR summary (README only) and actual deliverable (full codebase).	Verify git history and PR scope. This is an initial project commit, not the described "docs-only README PR" from issue #118.

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main documentation change about clarifying OpenResty LuaJIT as the primary supported runtime.
Linked Issues check	✅ Passed	All stated objectives from issue #118 are met: OpenResty LuaJIT is positioned as primary runtime, PUC Lua unsupported status is clarified, LuaRocks install targets Lua 5.1, build/runtime requirements are separated, and stock-LuaJIT caveats are retained.
Out of Scope Changes check	✅ Passed	All changes are focused on README documentation updates directly addressing issue #118 objectives; no out-of-scope modifications to code, configuration, or unrelated documentation sections.
Security Check	✅ Passed	Documentation-only PR with no code changes; README clarifies runtime scope and installation without exposing credentials, API keys, tokens, or sensitive data.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/issue-118-runtime-scope

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}