diff --git a/README.md b/README.md index 87ed5dd..3e9018f 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,24 @@ Its main purpose is to serve as an educational tool, teaching foundational progr The remainder of this README is yours to complete. Take this opportunity to describe your contributions, the design decisions you've made, and any other information you deem necessary. +# Task 1 - Partial Delivery 1 + +This project defines the basic entities for a card-based video game using Scala. +It includes classes for `Card`, `Rank`, `Suit`, `Joker`, `Hand`, and `Score`, each documented and independently tested. + +## Structure + +- `cards/` → Cards, ranks, and suits +- `jokers/` → Jokers with type as a string +- `hand/` → A hand containing a set of cards and jokers +- `score/` → Score with chips and multiplier + +## Testing + +All tests are written using [MUnit](https://scalameta.org/munit/) and located under `src/test/scala`. +The project achieves **90%+ test coverage** using `sbt-scoverage`. + +---