bump version, update readme

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
   # Run Black - the uncompromising Python code formatter
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 24.1.1
     hooks:
       - id: black-jupyter
 
@@ -23,7 +23,7 @@ repos:
   # Make sure that Jupyter notebooks under version control
   # have their outputs stripped before committing
   - repo: https://github.com/kynan/nbstripout
-    rev: 0.6.1
+    rev: 0.7.1
     hooks:
       - id: nbstripout
         files: ".ipynb"

calculate-liam/README.md

@@ -12,7 +12,7 @@ Then you can install this package from test PyPI:
 
 `pip install -i https://test.pypi.org/simple/ calculate-liam`
 
-## Use
+## Python use
 
 ```python
 from calculate_liam import stats
@@ -21,3 +21,16 @@ print(stats.flip_coin())
 
 print(stats.roll_dice(n_dice=2, n_sides=12))
 ```
+
+## Command line use
+
+```bash
+$ flip-coin
+Tails
+$ roll-dice --n-dice=2 --n-sides=12
+
+ 8
+
+ 5
+
+```

calculate-liam/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "calculate-liam"
-version = "0.0.2"
+version = "0.0.3"
 dependencies = ["click", "numpy"]
 authors = [
   { name="Liam Keegan", email="[email protected]" },

calculate-minimal/README.md

@@ -1,6 +1,6 @@
 # calculate-minimal
 
-A bare-bones minimal example of a Python package - for a more complete version see [calculate](../calculate).
+A bare-bones minimal example of a Python package - for a more complete version see [calculate-liam](../calculate-liam).
 
 ## Local install