Skip to content

Commit

Permalink
📝 Update Readme and Changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
smidf committed Aug 17, 2021
1 parent c459e71 commit ca08f21
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 8 deletions.
6 changes: 2 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
Change Log
==========

## 2.3.1 (TBD)

## 2.3.0 (2021-08-17)

### Updated:
- All dependencies.
- All dependencies
- OpenApiCodegen to 5.2.1 (https://github.com/OpenAPITools/openapi-generator/releases/tag/v5.2.1)
- Gradle to 7.1.1.
- Gradle to 7.1.1

### Added:
- Support for Kotlin Multiplatform `kotlinx.datetime` date library
Expand Down
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,52 @@
# OpenApi 3 Codegen / Swagger

[ ![Download](https://nexus.eman.cz/repository/maven-public/cz/eman/swagger/swagger-codegen/2.3.0/swagger-codegen-2.3.0.jar) ](https://nexus.eman.cz/#browse/browse:maven-public:cz%2Feman%2Fswagger%2Fswagger-codegen)
[![Latest version](https://img.shields.io/github/v/release/eManPrague/swagger-codegen)](https://github.com/eManPrague/swagger-codegen/releases/tag/v2.3.0)

The Swagger codegen contains a template-driven engine to generate documentation, code for Java, Kotlin and Android such like Retrofit and Room. It is a fork of the https://github.com/OpenAPITools/openapi-generator with modifications

### How to use it?

### Usage

:warning: The artifacts were moved from JCenter.

### Gradle

#### 1. Add jCenter and codegen dependency
#### 1. Add eMan Nexus and codegen dependency

All artifacts are available and distributed using the [eMan Nexus](https://nexus.eman.cz/service/rest/repository/browse/maven-public/) repository.
Add the repository to project `build.gradle.kts` (`build.gradle`) file.

```kotlin
buildscript {

repositories {
jcenter()
...
maven(url = "https://nexus.eman.cz/repository/maven-public")
}

// Kotlin Gradle DSL
dependencies {
...
classpath("cz.eman.swagger:swagger-codegen:2.3.0")
}
}
```

```groovy
buildscript {
repositories {
...
maven { url 'https://nexus.eman.cz/repository/maven-public' }
}
dependencies {
...
classpath 'cz.eman.swagger:swagger-codegen:2.3.0'
}
}
```

#### 2. Apply plugin in your artifact's module

```Kotlin
Expand Down

0 comments on commit ca08f21

Please sign in to comment.