Update installation instructions for wordguess#41
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request updates the installation instructions in the README to install the wordguess package directly from GitHub instead of from PyPI. The change addresses issue #30 by modifying the pip install command to use the GitHub repository URL.
Changes:
- Updated pip installation command from
pip install wordguesstopip install git+https://github.com/UBC-MDS/wordguess.git
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```bash | ||
| $ pip install wordguess | ||
| $ pip install git+https://github.com/UBC-MDS/wordguess.git |
There was a problem hiding this comment.
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).
README.mdwith installation instructions #30