crickets-and-comb / crickets-and-comb/reference_package

Update README example CLI calls (here and elsewhere)

Open
#31 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
Python
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

In the README, we have:
"""
Try the example CLI:

$ python -m example
$ python -m example --seconds 2
"""

But, setting up the CLI should result in calling like so:
```
$ example
$ example --seconds 2
```

We need to update the README to reflect this.

We may need to update the README in other Crickets and Comb repos if we haven't already, and if relevant (like `bfb_delivery`).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.