diff --git a/spring-cloud-stream-samples/sink/README.md b/spring-cloud-stream-samples/sink/README.md index 5b0de38a5..28c6f188a 100644 --- a/spring-cloud-stream-samples/sink/README.md +++ b/spring-cloud-stream-samples/sink/README.md @@ -1,29 +1,31 @@ -Spring Cloud Streams Sink Sample +Spring Cloud Stream Sink Sample ============================= -In this sample for *Spring Cloud Streams* this sink module will receive messages from the stream and write the payload to console. +In this *Spring Cloud Stream* sample, messages are received from a stream and the payload of each is logged to the console. ## Requirements -In order for the sample to run you will need to have installed: +To run this sample, you will need to have installed: * Java 7 or Above +This example requires Redis to be running on localhost. + ## Code Tour -This sample is a Spring Boot application that uses Spring Cloud Streams to retrieve data from a stream and write result to the console. The sink module has 2 primary components +This sample is a Spring Boot application that uses Spring Cloud Stream to receive messages and write each payload to the console. The sink module has 2 primary components: + +* SinkApplication - the Spring Boot Main Application +* LogSink - the module that receives the data from the stream and writes it out to the console -* SinkApplication - in which is the Spring Boot Main Application -* LogSink - the module that receives the data from the stream and writes it out to console. ## Building with Maven -Build the sample simply by executing: +Build the sample by executing: sink>$ mvn clean package ## Running the Sample -This example requires a local instance of Redis to be up an running. To start the sink module execute the following: sink>$ java -jar target/spring-cloud-streams-sample-sink-1.0.0.BUILD-SNAPSHOT-exec.jar diff --git a/spring-cloud-stream-samples/source/README.md b/spring-cloud-stream-samples/source/README.md index e628655a9..96cbc1425 100644 --- a/spring-cloud-stream-samples/source/README.md +++ b/spring-cloud-stream-samples/source/README.md @@ -1,36 +1,37 @@ -Spring Cloud Streams Source Sample +Spring Cloud Stream Source Sample ============================= -In this sample for *Spring Cloud Streams* we will post a timestamp to the stream on an interval determined by the fixedDelay configuration. +In this *Spring Cloud Stream* sample, a timestamp is published on an interval determined by the fixedDelay property. ## Requirements -In order for the sample to run you will need to have installed: +To run this sample, you will need to have installed: * Java 7 or Above +This example requires Redis to be running on localhost. + ## Code Tour -This sample is a Spring Boot application that uses Spring Cloud Streams to send time stamp data to a stream. The source module has 3 primary components +This sample is a Spring Boot application that uses Spring Cloud Stream to publish timestamp data. The source module has 3 primary components: -* SourceApplication - in which is the Spring Boot Main Application +* SourceApplication - the Spring Boot Main Application * TimeSource - the module that will generate the timestamp and post the message to the stream * TimeSourceOptionsMetadata - defines the configurations that are available to setup the TimeSource * format - how to render the current time, using SimpleDateFormat - * fixedDelay - time delay between messages, expressed in TimeUnits (seconds by default) - * initialDelay - an initial delay when using a fixed delay trigger, expressed in TimeUnits (seconds by default) + * fixedDelay - time delay between messages + * initialDelay - delay before the first message * timeUnit - the time unit for the fixed and initial delays * maxMessages - the maximum messages per poll; -1 for unlimited ## Building with Maven -Build the sample simply by executing: +Build the sample by executing: source>$ mvn clean package ## Running the Sample -This example requires a local instance of Redis to be up an running. To start the source module execute the following: source>$ java -jar target/spring-cloud-streams-sample-source-1.0.0.BUILD-SNAPSHOT-exec.jar