From 21cdcd6586c5720b8132caa250ba5afa528d6205 Mon Sep 17 00:00:00 2001 From: Harry Yau Date: Sat, 10 Jan 2026 12:33:05 -0800 Subject: [PATCH 1/4] add summary --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c8e9d50..59e2488 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,8 @@ *TODO: the above badges that indicate python version and package version will only work if your package is on PyPI. If you don't plan to publish to PyPI, you can remove them.* -wordguess is a project that (describe what it does here). +## Summary +The wordguess package is designed for creating and playing a word guessing game. The package provides functionality to set up the game, manage user inputs, and check guesses against a target word. It can compare user guesses to the target word and provide feedback on the accuracy of the guesses in terms of correct letters and their positions including numerical and human readable expressions. Additionally, features for scoring and hinting are included to enhance development of word guessing games. ## Get started From 4911da37a49859f19d11d4f253b6fa5796b112f2 Mon Sep 17 00:00:00 2001 From: Harry Yau Date: Sat, 10 Jan 2026 12:47:08 -0800 Subject: [PATCH 2/4] edit summary --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 59e2488..0e3df3a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ If you don't plan to publish to PyPI, you can remove them.* ## Summary -The wordguess package is designed for creating and playing a word guessing game. The package provides functionality to set up the game, manage user inputs, and check guesses against a target word. It can compare user guesses to the target word and provide feedback on the accuracy of the guesses in terms of correct letters and their positions including numerical and human readable expressions. Additionally, features for scoring and hinting are included to enhance development of word guessing games. +The wordguess package is designed for developer to create guessing game. The package provides functionality for word validation, feedback generation, corpus managementd. It can compare user guesses to the target word and provide feedback on the accuracy of the guesses in terms of correct letters and their positions including numerical and human readable expressions. Additionally, features for scoring and hinting are included to enhance development of word guessing games. wordguess provides the back-end foundation needed to handle the underlying string comparisons and state tracking. ## Get started From 0593e7bef57eb9615ec727bcbdeb6db380432f57 Mon Sep 17 00:00:00 2001 From: Harry Yau Date: Sat, 10 Jan 2026 13:59:36 -0800 Subject: [PATCH 3/4] change grammar and added backtick --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 14069ec..d4c62bc 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ wordguess is a project that contains essential functions for a word-guessing game, inspired by Wordle. ## Summary -The wordguess package is designed for developer to create guessing game. The package provides functionality for word validation, feedback generation, corpus managementd. It can compare user guesses to the target word and provide feedback on the accuracy of the guesses in terms of correct letters and their positions including numerical and human readable expressions. Additionally, features for scoring and hinting are included to enhance development of word guessing games. wordguess provides the back-end foundation needed to handle the underlying string comparisons and state tracking. +The `wordguess` package is designed for developer to create guessing game. The package provides functionality for word validation, feedback generation, corpus management. It can compare user guesses to the target word and provide feedback on the accuracy of the guesses in terms of correct letters and their positions including numerical and human readable expressions. Additionally, features for scoring and hinting are included to enhance development of word guessing games. `wordguess` provides the back-end foundation needed to handle the underlying string comparisons and state tracking. -wordguess fits perfectly into the Python ecosystem by offering a simple foundation for word-based projects. It uses standard Python practices, making it a great tool for learning to code or for developers who want to quickly add logic to their game ideas. Because the package emphasizes clean type-hinting and standardized docstrings, it serves as an excellent resource for developers learning about string manipulation, algorithmic logic, and package distribution. It bridges the gap between simple script-based games and production-ready modular code. +`wordguess` fits perfectly into the Python ecosystem by offering a simple foundation for word-based projects. It uses standard Python practices, making it a great tool for learning to code or for developers who want to quickly add logic to their game ideas. Because the package emphasizes clean type-hinting and standardized docstrings, it serves as an excellent resource for developers learning about string manipulation, algorithmic logic, and package distribution. It bridges the gap between simple script-based games and production-ready modular code. ## Get started You can install this package into your preferred Python environment using pip: From 3f48c17608da9267235ee3ba0c2680cab151a567 Mon Sep 17 00:00:00 2001 From: Harry Yau Date: Sat, 10 Jan 2026 14:45:30 -0800 Subject: [PATCH 4/4] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d4c62bc..e2705b3 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ wordguess is a project that contains essential functions for a word-guessing game, inspired by Wordle. ## Summary -The `wordguess` package is designed for developer to create guessing game. The package provides functionality for word validation, feedback generation, corpus management. It can compare user guesses to the target word and provide feedback on the accuracy of the guesses in terms of correct letters and their positions including numerical and human readable expressions. Additionally, features for scoring and hinting are included to enhance development of word guessing games. `wordguess` provides the back-end foundation needed to handle the underlying string comparisons and state tracking. +The `wordguess` package is designed for developers to create guessing games. The package provides functionality for word validation, feedback generation, corpus management. It can compare user guesses to the target word and provide feedback on the accuracy of the guesses in terms of correct letters and their positions including numerical and human readable expressions. Additionally, features for scoring and hinting are included to enhance development of word guessing games. `wordguess` provides the back-end foundation needed to handle the underlying string comparisons and state tracking. `wordguess` fits perfectly into the Python ecosystem by offering a simple foundation for word-based projects. It uses standard Python practices, making it a great tool for learning to code or for developers who want to quickly add logic to their game ideas. Because the package emphasizes clean type-hinting and standardized docstrings, it serves as an excellent resource for developers learning about string manipulation, algorithmic logic, and package distribution. It bridges the gap between simple script-based games and production-ready modular code.