Skip to content

Update installation instructions for wordguess #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sgauth01 merged 1 commit into from
Jan 17, 2026
Merged

Update installation instructions for wordguess #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The `wordguess` package is designed for developers to create guessing games. The
You can install this package into your preferred Python environment using pip:

```bash
$ pip install wordguess
$ pip install git+https://github.com/UBC-MDS/wordguess.git
Copy link

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The installation instruction now points to GitHub, but the README still contains PyPI badges at line 5 and the pyproject.toml references PyPI at line 46. This creates an inconsistency. If the package is not yet published to PyPI, consider removing or commenting out the PyPI badges in the README header. Alternatively, if the package will be published to PyPI in the future, consider documenting both installation methods (PyPI for stable releases and GitHub for development versions).

Copilot uses AI. Check for mistakes.
```

To use `wordguess` in your code:
Expand Down
Loading