diff --git a/README.adoc b/README.adoc index ad2257a8..a0776062 100644 --- a/README.adoc +++ b/README.adoc @@ -3,9 +3,7 @@ :version: 0.1.0 :hardbreaks: -image:https://travis-ci.org/RobWin/swagger2markup.svg["Build Status", link="https://travis-ci.org/RobWin/swagger2markup"] image:https://coveralls.io/repos/RobWin/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/RobWin/swagger2markup"] image:http://img.shields.io/:version-{version}-blue.svg["Semantic Versioning", link="http://semver.org"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] - -WARNING: Still under heavy development +image:https://travis-ci.org/RobWin/swagger2markup.svg["Build Status", link="https://travis-ci.org/RobWin/swagger2markup"] image:https://coveralls.io/repos/RobWin/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/RobWin/swagger2markup"] image:http://img.shields.io/:version-{version}-blue.svg["Semantic Versioning", link="https://bintray.com/robwin/maven/swagger2markup/0.1.0/view"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] == Overview @@ -15,6 +13,40 @@ The primary goal of this project is to simplify the documentation of RESTful API == Usage +=== Adding Swagger2MarkupConverter + +==== Maven + +[source,xml] +---- + + + jcenter-release + jcenter + http://oss.jfrog.org/artifactory/oss-release-local/ + + + + + com.mangofactory + swagger-springmvc + 0.9.5 + +---- + +==== Gradle + +[source,groovy] +---- +repositories { + jcenter() +} + +compile "com.mangofactory:swagger-springmvc:0.9.5" +---- + +=== Using Swagger2MarkupConverter + Using the Swagger2MarkupConverter is simple. For instance, you can generate your AsciiDoc/Markdown documentation using https://github.com/spring-projects/spring-boot[Spring Boot] and https://github.com/martypitt/swagger-springmvc[swagger-springmvc] as follows: [source,java] diff --git a/build.gradle b/build.gradle index 6dea97db..f09b2d38 100644 --- a/build.gradle +++ b/build.gradle @@ -21,7 +21,7 @@ version = '0.1.0' group = 'io.swagger2markup' apply plugin: 'java' -apply plugin: 'maven' +apply plugin: 'maven-publish' apply plugin: 'org.asciidoctor.convert' apply plugin: 'jacoco' apply plugin: 'com.github.kt3k.coveralls' @@ -40,7 +40,6 @@ tasks.withType(JavaCompile) { repositories { jcenter() mavenCentral() - mavenLocal() } dependencies { diff --git a/gradle/publishing.gradle b/gradle/publishing.gradle index 9bc7237f..2809d763 100644 --- a/gradle/publishing.gradle +++ b/gradle/publishing.gradle @@ -29,8 +29,47 @@ if (!project.hasProperty('bintrayApiKey')) ext.bintrayApiKey = '' bintray { user = project.bintrayUsername key = project.bintrayApiKey + publications = ['mavenJava'] pkg { repo = 'maven' name = 'swagger2markup' + websiteUrl = 'https://github.com/RobWin/swagger2markup' + issueTrackerUrl = 'https://github.com/RobWin/swagger2markup/issues' + vcsUrl = 'https://github.com/RobWin/swagger2markup.git' + desc = 'A Swagger to Markup (AsciiDoc and Markdown) converter.' + licenses = ['Apache-2.0'] + version { + vcsTag = project.version + } + } +} + +publishing { + publications { + mavenJava(MavenPublication) { + from components.java + pom.withXml { + def devs = ['RobWin': 'Robert Winkler'] + def root = asNode() + root.appendNode('name', 'swagger2markup') + root.appendNode('packaging', 'jar') + root.appendNode('url', 'https://github.com/RobWin/swagger2markup') + root.appendNode('description', 'A Swagger to Markup (AsciiDoc and Markdown) converter.') + + def license = root.appendNode('licenses').appendNode('license') + license.appendNode('name', 'Apache-2.0') + license.appendNode('url', 'https://github.com/RobWin/swagger2markup/blob/master/LICENSE.txt') + license.appendNode('distribution', 'repo') + + root.appendNode('scm').appendNode('url', 'https://github.com/RobWin/swagger2markup.git') + + def developers = root.appendNode('developers') + devs.each { + def d = developers.appendNode('developer') + d.appendNode('id', it.key) + d.appendNode('name', it.value) + } + } + } } } \ No newline at end of file