Skip to content

Commit

Permalink
Minor clean-up of readmes.
Browse files Browse the repository at this point in the history
  • Loading branch information
@zvoneg
zvoneg committed Sep 15, 2017
1 parent 04cd71f commit 26d950d
Show file tree
Hide file tree
Showing 27 changed files with 153 additions and 50 deletions.
2 changes: 0 additions & 2 deletions bean-validation/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
87 changes: 87 additions & 0 deletions https/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,90 @@ The application/service can be accessed on the following URL:
- https://localhost:\<ssl_port\>/v1/customers

To shut down the example simply stop the processes in the foreground.

##Tutorial

We will follow these steps:
* Add maven dependencies
* Implement microservice
* Build
* Run microservice

### Add maven dependencies

To implement microservice add the following dependencies
```xml
<dependencies>
<dependency>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-core</artifactId>
</dependency>
<dependency>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-servlet-jetty</artifactId>
</dependency>
<dependency>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-jax-rs-jersey</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-jdk14</artifactId>
<version>1.7.25</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
</dependencies>
```

Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-jar:

```xml
<build>
<plugins>
<plugin>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-maven-plugin</artifactId>
<version>${kumuluzee.version}</version>
<executions>
<execution>
<id>package</id>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
```

or exploded:

```xml
<build>
<plugins>
<plugin>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-maven-plugin</artifactId>
<version>${kumuluzee.version}</version>
<executions>
<execution>
<id>package</id>
<goals>
<goal>copy-dependencies</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
```

### Build the microservice and run it

To build the microservice and run the example, use the commands as described in previous sections.
2 changes: 0 additions & 2 deletions jax-ws/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions jpa/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions jsf/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions jsp/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-config-consul/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-config-etcd/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-config/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-cors/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-discovery-consul/discovery-consul-discover-jaxrs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja
or exploded:
Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:
```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-discovery-consul/discovery-consul-discover-servlet/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-discovery-consul/discovery-consul-register/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-discovery-etcd/discovery-etcd-discover-jaxrs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja
or exploded:
Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:
```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-discovery-etcd/discovery-etcd-discover-servlet/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-discovery-etcd/discovery-etcd-register/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-logs-jul/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-logs-log4j2/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
65 changes: 65 additions & 0 deletions kumuluzee-logs-simple/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,71 @@ We will follow these steps:
* Build the microservice
* Run it

### Add maven dependencies

The following dependencies are required for implementation:

```xml
<dependencies>
<dependency>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-core</artifactId>
</dependency>
<dependency>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-servlet-jetty</artifactId>
</dependency>
<dependency>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-jax-rs-jersey</artifactId>
</dependency>
</dependencies>
```

Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-jar:

```xml
<build>
<plugins>
<plugin>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-maven-plugin</artifactId>
<version>${kumuluzee.version}</version>
<executions>
<execution>
<id>package</id>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
```

or exploded:

```xml
<build>
<plugins>
<plugin>
<groupId>com.kumuluz.ee</groupId>
<artifactId>kumuluzee-maven-plugin</artifactId>
<version>${kumuluzee.version}</version>
<executions>
<execution>
<id>package</id>
<goals>
<goal>copy-dependencies</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
```

### Configure java.util.logging configuration

The default java.util.logging configuration can be configured by providing the location of the custom configuration
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-rest/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-security-cdi-keycloak/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-security-keycloak/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions kumuluzee-streaming-kafka/kumuluzee-streaming-kafka-consumer/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
3 changes: 1 addition & 2 deletions kumuluzee-streaming-kafka/kumuluzee-streaming-kafka-producer/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ If you would like to collect Kafka related logs through the KumuluzEE Logs, you
<version>2.8.1</version>
</dependency>
```

Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-jar:

```xml
Expand All @@ -213,8 +214,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions microservices-simple/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions servlet/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down
2 changes: 0 additions & 2 deletions websocket/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,6 @@ Add the `kumuluzee-maven-plugin` build plugin to package microservice as uber-ja

or exploded:

Add the `kumuluzee-maven-plugin` build plugin to package microservice as exploded:

```xml
<build>
<plugins>
Expand Down

0 comments on commit 26d950d

Please sign in to comment.