Skip to content

Commit cefb65c

Browse files
committed
#3 - updated README with installation instructions
1 parent a97a98b commit cefb65c

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,16 @@ Basic packages containing all the Python dependencies for the Coder Dojo Session
44

55
## Installation
66

7-
[//]: # (TODO: Update documentation)
7+
You can install the package from GitHub using the following command.
8+
9+
```shell
10+
pip install 'coder_dojo_common_python[games,data] @ https://github.com/Stedders/coder-dojo-common-python/releases/download/v0.0.1/coder_dojo_common_python-0.0.1-py3-none-any.whl'
11+
```
12+
13+
This will install the games and data packages for the v0.0.1 release.
14+
15+
As packages are updated or new packages added a new version will be published, please check the latest version
16+
at https://github.com/Stedders/coder-dojo-common-python/releases.
817

918
## Development
1019

@@ -26,7 +35,8 @@ poetry add requests --optional
2635

2736
You will then need to update the extra information to ensure the package is in the correct group.
2837

29-
Either update the appropriate extras section or create a new section under extras in the [pyproject.toml](pyproject.toml) file.
38+
Either update the appropriate extras section or create a new section under extras in
39+
the [pyproject.toml](pyproject.toml) file.
3040

3141
```toml
3242
[tool.poetry.dependencies]

0 commit comments

Comments
 (0)