docs: add comprehensive README documentation

[wolf31o2]

Summary

This PR adds comprehensive documentation to the README.md file, including:

• Environment Variables: Complete documentation of all configuration options with descriptions and default values
• Application Workflow: Step-by-step breakdown of how the application works from startup through transaction submission
• Building and Running: Instructions for building and running the application

Changes Made

• Enhanced the README with detailed environment variable documentation
• Added workflow documentation explaining each component's role
• Included build and run instructions
• Provided clear overview of the Cardano indexer and reward system

Why This Change?

The previous README was minimal and didn't provide users with enough information to understand:

• How to configure the application
• How the system works internally
• How to get started with the application

This documentation will help users quickly understand and use the workshop application effectively.

Testing

• Documentation is clear and comprehensive
• Environment variables match the actual code implementation
• Workflow description accurately reflects the codebase

Closes #7

Summary by CodeRabbit

• Documentation
  • Expanded README with detailed environment variable configuration, setup guidance, and recommended best practices.
  • Added comprehensive application workflow documentation describing key processes and interactions.
  • Included clear step-by-step build and runtime instructions to simplify developer setup and deployment.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request adds comprehensive documentation to README.md describing environment variables, application workflow, and build/run instructions. No source code, logic, error handling, control flow, or public/exported declarations were changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Documentation-only change; single file modified: README.md
• Review focus: clarity, accuracy, completeness of README content

Pre-merge checks and finishing touches

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title clearly and concisely describes the main change: adding comprehensive README documentation, which directly matches the changeset.
Linked Issues check	✅ Passed	The PR successfully addresses issue #7 objectives: it documents all environment variables with descriptions and default values, and documents the overall application workflow including startup and transaction submission flow.
Out of Scope Changes check	✅ Passed	All changes are in scope—only README.md documentation was modified to fulfill the stated objectives; no unrelated code or behavioral changes are present.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/add-readme-documentation

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 55bdeea and 8c69b02.

📒 Files selected for processing (1)

• README.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• README.md

---

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: 0

🧹 Nitpick comments (1)

README.md (1)

5-35: Well-structured environment variables documentation.

The organization by functional area is clear, and defaults are documented. Consider adding a brief indicator (e.g., "required" or "optional") for key variables to help users understand which settings must be configured—especially MNEMONIC (which has fallback logic) and the connector choices (Indexer, Submit, TxBuilder).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2e00cc5 and 55bdeea.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (3)

README.md (3)

1-3: Strong project description.

The title and description are clear and immediately convey the project's purpose to users.

---

37-63: Clear and logical application workflow description.

The step-by-step progression from startup through transaction submission is easy to follow and well-documented. Each step appropriately references the relevant code file. Per the PR description, this has been verified to reflect the codebase.

Verify that the referenced file paths (cmd/workshop/main.go, internal/wallet/wallet.go, etc.) remain accurate if any code reorganization occurs.

---

65-79: Clear build and run instructions.

The build and run commands are straightforward, and the explanation of what the application does is helpful for first-time users.