From cede2d57db81e5793dba0cd7c45ac5443c3c06f8 Mon Sep 17 00:00:00 2001 From: andrewsy-opal Date: Wed, 27 Nov 2024 15:08:31 -0500 Subject: [PATCH] minor README update --- .openapi-generator/templates/README.mustache | 5 +++-- README.md | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.openapi-generator/templates/README.mustache b/.openapi-generator/templates/README.mustache index 816f0fe..5e086d1 100644 --- a/.openapi-generator/templates/README.mustache +++ b/.openapi-generator/templates/README.mustache @@ -6,13 +6,14 @@ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: {{appVersion}} -- Package version: {{packageVersion}} +- [Releases](https://github.com/opalsecurity/opal-python/releases/) {{^hideGenerationTimestamp}} - Build date: {{generatedDate}} {{/hideGenerationTimestamp}} - Generator version: {{generatorVersion}} - Build package: {{generatorClass}} {{#infoUrl}} + For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) {{/infoUrl}} @@ -24,7 +25,7 @@ Python {{{generatorLanguageVersion}}} ### pip install We recommend installing from [PyPI](https://pypi.org) using `pip`: ```sh -pip install {{{packageName}}} +pip install {{{projectName}}} ``` You can also install via git: diff --git a/README.md b/README.md index 80143f6..b102c18 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,10 @@ Your Home For Developer Resources. This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.0 -- Package version: 1.0.0 +- [Releases](https://github.com/opalsecurity/opal-python/releases/) - Generator version: 7.10.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen + For more information, please visit [https://www.opal.dev/](https://www.opal.dev/) ## Requirements. @@ -17,7 +18,7 @@ Python 3.8+ ### pip install We recommend installing from [PyPI](https://pypi.org) using `pip`: ```sh -pip install opal_security +pip install opal-security ``` You can also install via git: