From 9371a52fdebce77710e48d3e55512f1869ebad20 Mon Sep 17 00:00:00 2001 From: Dominic Ricottone Date: Tue, 13 Sep 2022 15:03:19 -0500 Subject: [PATCH] Documentation update --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eccff6f..71bf0c8 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,23 @@ A package that uses external configuration files to generate a static, standalone parser module. +## Usage + +To install, try: + +``` +pipx install git+https://git.dominic-ricottone.com/~dricottone/gap +``` + + ## To-Do Python 3.11 introduces a `tomllib` module. **Release 1.0.2** will continue to work perfectly for Python 3.6 or later. **Release 1.0.3** will continue to -function perfectly as well, but the test suite will fail due to `mypy` not -having type stubs for `tomllib`. **Release 1.0.4** will drop `toml` as a -dependency and therefore drop support for Python 3.10 or earlier. +function perfectly as well, but the test suite will fail with Python 3.10 or +earlier due to `mypy` not having type stubs for `tomllib`. **Release 1.0.4** +will drop `toml` as a dependency and therefore drop support for Python 3.10 or +earlier. ## Workflow -- 2.45.2