Skip to content

Add files via upload#262

Open
0xBernny wants to merge 1 commit into
Invoice-Liquidity-Network:mainfrom
0xBernny:docs/indexer-readme
Open

Add files via upload#262
0xBernny wants to merge 1 commit into
Invoice-Liquidity-Network:mainfrom
0xBernny:docs/indexer-readme

Conversation

@0xBernny

Copy link
Copy Markdown

closes #257

Summary

Related Issue

Closes #257

Complexity

  • Trivial (typo, docs, small refactor)
  • [✔️ ] Medium (new feature, bug fix)
  • High (major refactor, breaking change, security-critical)

Changes Made

  • Created a brand-new indexer/README.md file containing architecture overviews, environment variable references, Docker instructions, and REST API payload examples.
  • Updated the repository's root README.md file to cleanly link directly to the new indexer documentation.

Test Coverage

N/A - Pure documentation task. Verified markdown structure renders cleanly.

# Example:
# cargo test
# running 15 tests
# test result: ok. 15 passed; 0 failed
Test output

Security Considerations

N/A. This pull request only introduces helpful public documentation and does not expose any private database URLs, deployment secrets, or environment variables.

Checklist

  • [✔️ ] Code follows project conventions (see CONTRIBUTING.md)
  • Tests added/updated and passing
  • Documentation updated (if needed)
  • [ ✔️] Commit message follows Conventional Commits
  • No secrets or sensitive data in code
  • Breaking changes documented (if applicable)

@drips-wave

drips-wave Bot commented Jun 28, 2026

Copy link
Copy Markdown

@0xBernny Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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.

Write indexer/README.md with deployment and API reference

1 participant