Skip to content

Commit 8d4afa3

Browse files
committed
Update README.md and LICENSE
- strip needless executable permissions from both files - fix markdownlint-cli errors of README.md - append info java binar is needed to run
1 parent 8a5d417 commit 8d4afa3

2 files changed

Lines changed: 24 additions & 12 deletions

File tree

LICENSE

100755100644
File mode changed.

README.md

100755100644
Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,29 @@
11
# OpenApi Generator PIP Package Generator
22

3-
[![Join the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g)
4-
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
5-
6-
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and
7-
configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Please see
8-
[OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator)
3+
[![Join the Slack chat room](
4+
<https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange>
5+
)](
6+
<https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g>
7+
) [![Code style: black](
8+
<https://img.shields.io/badge/code%20style-black-000000.svg>
9+
)](
10+
<https://github.com/psf/black>
11+
) [![Ruff](
12+
<https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json>
13+
)](
14+
<https://github.com/astral-sh/ruff>
15+
)
16+
17+
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Please see [OpenAPITools/openapi-generator]
918

1019
---
1120

12-
This project checks the [maven repository](https://mvnrepository.com/artifact/org.openapitools/openapi-generator-cli)
13-
once a day for a new version and will publish this new version automatically as a python package.
21+
This project checks the [maven repository] once a day for a new version and will publish this new version automatically as a python package.
1422

1523
## Installation
1624

25+
You must have the `java` binary executable available on your PATH for this to work. (JDK 11 is the minimal version supported. To install OpenJDK, please visit <https://adoptium.net/>)
26+
1727
You can install the package either in a virtual environment or globally.
1828

1929
```sh
@@ -24,8 +34,7 @@ pip install openapi-generator-cli
2434
pip install openapi-generator-cli==4.3.1
2535
```
2636

27-
After installation `openapi-generator` command will be available in your virtual environment or globally
28-
depending on your installation
37+
After installation `openapi-generator` command will be available in your virtual environment or globally depending on your installation.
2938

3039
To check the version, for example. Type the following command
3140

@@ -36,8 +45,7 @@ openapi-generator version
3645

3746
## Further Documentation
3847

39-
Please refer to the [official openapi-generator docs](https://github.com/OpenAPITools/openapi-generator#3---usage) for
40-
more information about the possible arguments and a detailed usage manual of the command line interface.
48+
Please refer to the [official openapi-generator docs] for more information about the possible arguments and a detailed usage manual of the command line interface.
4149

4250
## Like the package?
4351

@@ -46,3 +54,7 @@ Please leave a star.
4654
## Have suggestions or feedback?
4755

4856
Please raise an issue, happy to hear from you :)
57+
58+
[OpenAPITools/openapi-generator]: <https://github.com/OpenAPITools/openapi-generator>
59+
[maven repository]: <https://mvnrepository.com/artifact/org.openapitools/openapi-generator-cli>
60+
[official openapi-generator docs]: <https://github.com/OpenAPITools/openapi-generator#3---usage>

0 commit comments

Comments
 (0)