Skip to content

Commit 69179f2

Browse files
authored
Added version badge and cleaned up documentation
1 parent c62afbe commit 69179f2

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= SpringFox Grails Integration
2-
2+
image::https://api.bintray.com/packages/springfox/maven-repo/springfox-grails-integration/images/download.svg[link="https://bintray.com/springfox/maven-repo/springfox-grails-integration/_latestVersion"]
33
image:https://circleci.com/gh/springfox/springfox-grails-integration.svg?style=svg["CircleCI", link="https://circleci.com/gh/springfox/springfox-grails-integration"]
44
image:https://codecov.io/gh/springfox/springfox-grails-integration/branch/master/graph/badge.svg["codecov",link="https://codecov.io/gh/springfox/springfox-grails-integration"]
55
image:https://api.codacy.com/project/badge/Grade/77fbd793eb06447d9f1bf47eb8cdad8b["Codacy code quality", link="https://www.codacy.com/app/dilip-krishnan-github/springfox-grails-integration?utm_source=github.com&utm_medium=referral&utm_content=springfox/springfox-grails-integration&utm_campaign=Badge_Grade"]
@@ -8,7 +8,9 @@ SpringFox Grails integration library that produces grails specific documentation
88

99
== Development Environment
1010

11-
To build from source using IntelliJ IDEA
11+
=== IDE setup
12+
13+
==== IntelliJ IDEA
1214

1315
- File >> open >> build.gradle
1416
- Make sure to check the 'use the default gradle wrapper' option.
@@ -19,9 +21,11 @@ To build from source using IntelliJ IDEA
1921

2022
```
2123

24+
=== Build
25+
2226
- To get more output from any gradle commands/tasks append a `-i` (info) or `-d` (debug) e.g.
2327
```bash
24-
./gradlew build -i
28+
./gradlew clean build -i
2529

2630
```
2731
- To publish to local maven repository
@@ -58,7 +62,7 @@ Below outlines how to include the springfox-swagger2 module which produces Swagg
5862

5963
TIP: Refer the main documentation on how to http://springfox.github.io/springfox/docs/current/#swagger-ui[include springfox bundled swagger-ui] dependencies
6064

61-
NOTE: Please refer the main documentation on to http://springfox.github.io/springfox/docs/current/#dependencies[including the springfox-swagger2 dependencies]
65+
NOTE: Please refer the main documentation on how to http://springfox.github.io/springfox/docs/current/#dependencies[include the springfox-swagger2 dependencies]
6266
which are required for this integration library to work.
6367

6468
=== Release
@@ -74,8 +78,6 @@ dependencies {
7478
}
7579
----
7680

77-
NOTE: This project has not been released yet.
78-
7981
=== Snapshot
8082

8183
[source,groovy]
@@ -90,9 +92,6 @@ dependencies {
9092
}
9193
----
9294

93-
NOTE: The current snapshot version that is available is `{snapshotVersion}`
94-
95-
9695
== Configuration
9796

9897
In your Application (GrailsAutoConfiguration) startup entry-point follow the steps below
@@ -168,6 +167,7 @@ link="https://bintray.com/springfox/maven-repo/springfox/_latestVersion"]
168167
The library comes with intelligent defaults imeplemented by `DefaultGrailsAlternateTypeRuleConvention`. However the
169168
defaults can be tweaked using one of these extensibility mechanisms. The following classes can be implemented and
170169
registered as a bean to augment default behavior.
170+
171171
- AlternateTypeRuleConvention - for adding custom conventions for replacing grails types
172172
- GrailsPropertySelector - for overriding the selection of grails properties by the default convention
173173
- GrailsPropertyTransformer - for overriding the transformer of the grails property

0 commit comments

Comments
 (0)