diff --git a/README.md b/README.md index fb120ac3a8c690d8c6a6ed8fc28e9c86f67dc6ae..9df135a7c8038552b32a894b1c05bd09a28f884a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Spring Boot - Maven 3 - CentOS Docker image -======================================== +# Spring Boot - Maven 3 - CentOS Docker image This repository contains the sources and [Dockerfile](https://github.com/codecentric/springboot-maven3-centos/blob/master/Dockerfile) @@ -10,8 +9,7 @@ or using [S2I](https://github.com/openshift/source-to-image). This image is heavily inspired by the awesome [openshift/sti-ruby](https://github.com/openshift/sti-ruby/) builder images. -Usage ---------------------- +## Usage To build a simple springboot-sample-app application using standalone S2I and then run the resulting image with Docker execute: @@ -26,8 +24,7 @@ $ docker run -p 8080:8080 spring-boot-app $ curl 127.0.0.1:8080 ``` -Repository organization ------------------------- +## Repository organization * **`s2i/bin/`** @@ -53,8 +50,7 @@ Repository organization archiving those. In this image, this script will archive the `/opt/java/.m2` directory. -Environment variables ---------------------- +## Environment variables * **APP_ROOT** (default: '.') @@ -62,8 +58,7 @@ Environment variables application GIT repository. In case your application is located in a sub-folder, you can set this variable to a *./myapplication*. -Contributing ------------- +## Contributing In order to test your changes to this STI image or to the STI scripts, you can use the `test/run` script. Before that, you have to build the 'candidate' image: @@ -75,7 +70,6 @@ $ docker build -t codecentric/springboot-maven3-centos-candidate . After that you can execute `./test/run`. You can also use `make test` to automate this. -Copyright --------------------- +## Copyright Released under the Apache License 2.0. See the [LICENSE](https://github.com/codecentric/springboot-maven3-centos/blob/master/LICENSE) file.