Skip to content

docs: add README with build instructions, env vars and project rationale#150

Open
fblan wants to merge 1 commit intomainfrom
feat/149-add-readme
Open

docs: add README with build instructions, env vars and project rationale#150
fblan wants to merge 1 commit intomainfrom
feat/149-add-readme

Conversation

@fblan
Copy link
Copy Markdown
Owner

@fblan fblan commented Apr 29, 2026

Summary

  • Add README.md at the repository root
  • Covers build & run instructions (dev mode, full Maven build, Docker)
  • Documents all environment variables with required/optional status and defaults
  • Includes a "why this project" section explaining the Claude Code learning rationale
  • Links to the live deployed instance at https://fairnsquare.web.asymetrik.org

Closes #149

Test plan

  • README renders correctly on GitHub
  • Build instructions are accurate (verify against pom.xml and docker/Dockerfile.jvm)
  • All env vars listed match what the application actually reads

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

docs: add README with build instructions, env variables and project rationale

1 participant