diff --git a/modules/swagger-codegen/src/main/resources/Java/README.mustache b/modules/swagger-codegen/src/main/resources/Java/README.mustache
index fff0bf0973c..6ec3efff471 100644
--- a/modules/swagger-codegen/src/main/resources/Java/README.mustache
+++ b/modules/swagger-codegen/src/main/resources/Java/README.mustache
@@ -1,24 +1,41 @@
# {{artifactId}}
+{{appName}}
+- API version: {{appVersion}}
+{{^hideGenerationTimestamp}}
+ - Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+
+{{#appDescription}}{{{appDescription}}}{{/appDescription}}
+
+{{#infoUrl}}
+ For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
+*Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*
+
+
## Requirements
-Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
+Building the API client library requires:
+1. Java 1.7+
+2. Maven/Gradle
## Installation
To install the API client library to your local Maven repository, simply execute:
```shell
-mvn install
+mvn clean install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
-mvn deploy
+mvn clean deploy
```
-Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
+Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
### Maven users
@@ -26,10 +43,10 @@ Add this dependency to your project's POM:
```xml
- {{{groupId}}}
- {{{artifactId}}}
- {{{artifactVersion}}}
- compile
+ {{{groupId}}}
+ {{{artifactId}}}
+ {{{artifactVersion}}}
+ compile
```
@@ -45,12 +62,14 @@ compile "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}"
At first generate the JAR by executing:
- mvn package
+```shell
+mvn clean package
+```
Then manually install the following JARs:
-* target/{{{artifactId}}}-{{{artifactVersion}}}.jar
-* target/lib/*.jar
+* `target/{{{artifactId}}}-{{{artifactVersion}}}.jar`
+* `target/lib/*.jar`
## Getting Started
diff --git a/modules/swagger-codegen/src/main/resources/akka-scala/README.mustache b/modules/swagger-codegen/src/main/resources/akka-scala/README.mustache
index 85c72cd1d16..eb2a9ba67ba 100644
--- a/modules/swagger-codegen/src/main/resources/akka-scala/README.mustache
+++ b/modules/swagger-codegen/src/main/resources/akka-scala/README.mustache
@@ -1,42 +1,40 @@
-# NAME
+# {{artifactId}}
{{appName}}
+- API version: {{appVersion}}
+{{^hideGenerationTimestamp}}
+ - Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
{{#appDescription}}{{{appDescription}}}{{/appDescription}}
-# VERSION
-
-Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
-
-- API version: {{appVersion}}
-- Package version: {{moduleVersion}}
-{{^hideGenerationTimestamp}}
-- Build date: {{generatedDate}}
-{{/hideGenerationTimestamp}}
-- Build package: {{generatorClass}}
{{#infoUrl}}
-For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+ For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
{{/infoUrl}}
-# Requirements
+*Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*
-Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
+## Requirements
+
+Building the API client library requires:
+1. Java 1.7+
+2. Maven/Gradle/SBT
## Installation
To install the API client library to your local Maven repository, simply execute:
```shell
-mvn install
+mvn clean install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
-mvn deploy
+mvn clean deploy
```
-Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
+Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
### Maven users
@@ -44,10 +42,10 @@ Add this dependency to your project's POM:
```xml
- {{{groupId}}}
- {{{artifactId}}}
- {{{artifactVersion}}}
- compile
+ {{{groupId}}}
+ {{{artifactId}}}
+ {{{artifactVersion}}}
+ compile
```
@@ -65,13 +63,15 @@ compile "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}"
libraryDependencies += "{{{groupId}}}" % "{{{artifactId}}}" % "{{{artifactVersion}}}"
```
+## Getting Started
+
## Documentation for API Endpoints
All URIs are relative to *{{basePath}}*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
-{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | **{{operationId}}** | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
## Documentation for Models
@@ -101,28 +101,6 @@ Class | Method | HTTP request | Description
{{/authMethods}}
-
-# BUILDING YOUR LIBRARY
-
-See the homepage `https://github.com/swagger-api/swagger-codegen` for full details.
-But briefly, clone the git repository, build the codegen codebase, set up your build
-config file, then run the API build script. You will need git, Java 7 or 8 and Apache
-maven 3.0.3 or better already installed.
-
-Your library files will be built under `WWW::MyProjectName`.
-
- $ git clone https://github.com/swagger-api/swagger-codegen.git
- $ cd swagger-codegen
- $ mvn package
- $ java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate \
- -i [URL or file path to JSON swagger API spec] \
- -l akka-scala \
- -c /path/to/config/file.json \
- -o /path/to/output/folder
-
-Bang, all done. Run the `autodoc` script in the `bin` directory to see the API
-you just built.
-
## Author
{{#apiInfo}}{{#apis}}{{^hasMore}}{{infoEmail}}