Add comprehensive README documentation for Code Send project

[mnindrazaka]

Summary

This PR adds extensive documentation to the README, transforming it from a single-line description into a complete guide for understanding and running the Code Send hot code update platform.

Changes Made

• Project overview: Added detailed explanation of what Code Send is, why hot code updates matter for React Native, and what the platform provides
• Architecture diagram: Included ASCII flow diagram showing the interaction between developer, platform, and user device
• Technical explanation: Documented the core mechanism (bundle override in MainApplication.java) and unique features (regional rollout and update targeting by history)
• Repository structure: Added table mapping each folder to its purpose and tech stack
• Key files guide: Provided curated list of essential files to understand the hot update mechanism, platform backend, and dashboard frontend
• API reference: Documented all REST endpoints with methods, routes, and purposes
• Setup instructions: Added detailed prerequisites and step-by-step commands for running backend, frontend, and plugin locally, including environment variable documentation
• Docker support: Documented containerized backend deployment
• Testing and building: Listed available npm scripts for each component
• Diagrams: Explained the design documents in the diagram/ folder and how to render them
• Deployment: Documented GitHub Actions CI/CD pipeline and hosted service URLs
• Limitations: Explicitly listed known constraints (Android-only, version matching approach, hard-coded MongoDB host, no bundle signature verification)

Notable Details

• Organized information hierarchically from high-level concepts to implementation details
• Included practical examples (e.g., React Native bundle command for testing updates)
• Provided environment variable reference tables for both backend and frontend
• Documented both local development and production deployment workflows
• Acknowledged the research/prototype nature of the codebase with explicit limitations section

https://claude.ai/code/session_01CK7puxcagcyABAQsmgW2hB

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
code-send	Error		Sep 2, 2026 12:15pm UTC