Skip to content

Commit 331249b

Browse files
authored
Merge pull request #37 from UBC-MDS/yhouyang02-patch-1
Enhance README with links and formatting fixes
2 parents 7e8551e + 08ce7a5 commit 331249b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
| Package | [![Latest PyPI Version](https://img.shields.io/pypi/v/wordguess.svg)](https://pypi.org/project/wordguess/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/wordguess.svg)](https://pypi.org/project/wordguess/) |
66
| Meta | [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) |
77

8-
Wordguess is a project that contains essential functions for a word-guessing game, inspired by Wordle.
8+
Wordguess is a project that contains essential functions for a word-guessing game, inspired by [Wordle](https://www.nytimes.com/games/wordle/index.html).
99

1010
## Summary
11-
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.
11+
The `wordguess` package is designed for developers to create guessing games. The package provides functionality for word validation, feedback generation, and 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.
1212

1313
`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.
1414

@@ -25,7 +25,7 @@ You can install this package into your preferred Python environment using pip:
2525
$ pip install wordguess
2626
```
2727

28-
To use wordguess in your code:
28+
To use `wordguess` in your code:
2929

3030
```python
3131
>>> import wordguess
@@ -67,7 +67,7 @@ To use wordguess in your code:
6767

6868
* `result_to_pattern(result)`
6969
* **Location:** `/src/wordguess/result_to_pattern.py`
70-
* **Description:** Converts a numerical `result` string into a human-readable `pattern` using UTF-8 Colored Symbols.
70+
* **Description:** Converts a numerical `result` string into a human-readable `pattern` using [UTF-8 Colored Symbols](https://www.utf8icons.com/).
7171
* **Parameters:**
7272
* **result** (*str*): A string of 0s, 1s, and 2s.
7373
* **Returns:** (*str*) A visual string of emojis (e.g., 🟩, 🟨, ⬛).

0 commit comments

Comments
 (0)