docs: Update README.md with project documentation - #131
Merged
Conversation
- Add professional badges (Build, Java version, Tests, Coverage) - Include Quick Start section with expected outputs - Add Project Structure tree for easy navigation - Document Features (CSV reading, writing, validation, streaming, error handling) - Add Architecture diagram with layered design explanation - Include How It Works section (Reading/Writing pipelines, FSM explanation) - Document Design Principles (Immutability, Separation of Concerns, Type Safety) - Add Development Approach section (TDD, Team Collaboration, Testing Challenges) - Include comprehensive Building and Testing instructions - Add Demo Application guide with sample data - Document Development Workflow and Code Quality Standards - Link to comprehensive documentation in /docs folder - Add Troubleshooting section with common issues and solutions - Include Team Members with student IDs - Add License section with course information - Reorganize sections for better navigation (Quick Start and Project Structure first) - Update with accurate metrics: 471 tests, 92% coverage, Java 21 - Incorporate insights from Team Collaboration Report and Testing Strategy Report Closes #130
MichaelMcKibbin
approved these changes
Dec 3, 2025
MichaelMcKibbin
left a comment
MichaelMcKibbin
left a comment
Owner
There was a problem hiding this comment.
That's a lot of work in a short time!
Collaborator
Author
Ain't no rest for the wicked xD |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated
README.mdfollowing some Java repository best practices.Used the draft readme_v2_draft.md and got insights from the Design, Collaboration, and Test Strategy reports.
/docsfolderCloses #130