chore: update README with MongoDB compatible API layer details

[zhangh43]

Summary by CodeRabbit

• Documentation
  • Updated README to describe the project as a pluggable MongoDB-compatible API layer, add an architecture overview, and include explicit use cases highlighting MongoDB compatibility and distributed performance/elasticity.
  • Clarified scope without changing any public/exported APIs.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@zhangh43 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 50 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 08ecf1e and ef6de4e.

📒 Files selected for processing (1)

• README.md

Walkthrough

README.md updated with two descriptive paragraphs identifying the repo as a pluggable MongoDB-compatible API layer built on EloqData's Data Substrate (with submodule dependencies) and adding a Use Cases line emphasizing MongoDB compatibility and distributed performance/elasticity.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added two paragraphs describing the project as a pluggable MongoDB-compatible API layer atop the Data Substrate, noted submodule dependencies, and introduced a Use Cases line highlighting MongoDB API compatibility and distributed performance/elasticity.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Update README #249: Overlapping README updates expanding MongoDB compatibility and architecture/use-case descriptions.

Suggested reviewers

• lzxddz

Poem

🐰 A rabbit reads the README light,
Plugs in MongoDB and hops with delight,
Substrate roots and use-cases clear,
Docs now whisper what we hold dear,
A tiny hop — the roadmap's bright.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: updating the README with details about a MongoDB-compatible API layer, which aligns with the file changes that add descriptive paragraphs about the API's MongoDB compatibility and architecture.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch r1

---

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.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@README.md`:
- Line 35: Update the README sentence that currently reads "plugable MongoDB
compatible API layer" to correct spelling and hyphenation: change "plugable" to
"pluggable" and "MongoDB compatible" to "MongoDB-compatible"; also update the
Architecture anchor link to use the lowercase fragment "#architecture" to match
the header slug (locate the sentence containing "plugable MongoDB compatible API
layer" and the link to [Architecture](`#Architecture`) and apply these text
fixes).

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Fix spelling, hyphenation, and the Architecture anchor link.

plugable → pluggable, hyphenate “MongoDB-compatible”, and use the lowercase fragment #architecture to match the header slug.

✅ Proposed fix

-This repo contains the code for the plugable MongoDB compatible API layer. See [Architecture](`#Architecture`) for more details. The API sits on top of EloqData's [Data Substrate](https://github.com/eloqdata/tx_service) modular database foundation and the dependencies are included as submodules.
+This repo contains the code for the pluggable MongoDB-compatible API layer. See [Architecture](`#architecture`) for more details. The API sits on top of EloqData's [Data Substrate](https://github.com/eloqdata/tx_service) modular database foundation and the dependencies are included as submodules.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	This repo contains the code for the plugable MongoDB compatible API layer. See [Architecture](#Architecture) for more details. The API sits on top of EloqData's [Data Substrate](https://github.com/eloqdata/tx_service) modular database foundation and the dependencies are included as submodules.
	This repo contains the code for the pluggable MongoDB-compatible API layer. See [Architecture](`#architecture`) for more details. The API sits on top of EloqData's [Data Substrate](https://github.com/eloqdata/tx_service) modular database foundation and the dependencies are included as submodules.

🧰 Tools

🪛 LanguageTool

[grammar] ~35-~35: Ensure spelling is correct
Context: ...). This repo contains the code for the plugable MongoDB compatible API layer. See [Arch...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

---

[grammar] ~35-~35: Use a hyphen to join words.
Context: ...ntains the code for the plugable MongoDB compatible API layer. See [Architecture]...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)

35-35: Link fragments should be valid
Expected: #architecture; Actual: #Architecture

(MD051, link-fragments)

🤖 Prompt for AI Agents

In `@README.md` at line 35, Update the README sentence that currently reads
"plugable MongoDB compatible API layer" to correct spelling and hyphenation:
change "plugable" to "pluggable" and "MongoDB compatible" to
"MongoDB-compatible"; also update the Architecture anchor link to use the
lowercase fragment "#architecture" to match the header slug (locate the sentence
containing "plugable MongoDB compatible API layer" and the link to
[Architecture](`#Architecture`) and apply these text fixes).