Skip to content

Commit 040438f

Browse files
migroskubartembilan
authored andcommitted
Refresh README
* Modernize the homepage of Spring Integration * Improve README.md file, so it has examples, explanations, and logo
1 parent 1f666bc commit 040438f

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,52 @@
1+
<img align="right" width="250" height="250" src="https://spring.io/images/projects/spring-integration-ed45c92142d821851bf6c771f4c556bb.svg">
2+
13
Spring Integration [<img src="https://build.spring.io/plugins/servlet/wittified/build-status/INT-MAIN">](https://build.spring.io/browse/INT-MAIN) [![Join the chat at https://gitter.im/spring-projects/spring-integration](https://badges.gitter.im/spring-projects/spring-integration.svg)](https://gitter.im/spring-projects/spring-integration?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
24
==================
35

6+
Extends the Spring programming model to support the well-known Enterprise Integration Patterns.
7+
Spring Integration enables lightweight messaging within Spring-based applications and supports integration with external systems via declarative adapters.
8+
Those adapters provide a higher-level of abstraction over Spring’s support for remoting, messaging, and scheduling.
9+
Spring Integration’s primary goal is to provide a simple model for building enterprise integration solutions while maintaining the separation of concerns that is essential for producing maintainable, testable code.
10+
11+
Using the Spring Framework encourages developers to code using interfaces and use dependency injection (DI) to provide a Plain Old Java Object (POJO) with the dependencies it needs to perform its tasks.
12+
Spring Integration takes this concept one step further, where POJOs are wired together using a messaging paradigm and individual components may not be aware of other components in the application.
13+
Such an application is built by assembling fine-grained reusable components to form a higher level of functionality.
14+
WIth careful design, these flows can be modularized and also reused at an even higher level.
15+
16+
In addition to wiring together fine-grained components, Spring Integration provides a wide selection of channel adapters and gateways to communicate with external systems.
17+
Channel Adapters are used for one-way integration (send or receive); gateways are used for request/reply scenarios (inbound or outbound).
18+
19+
# Installation and Getting Started
20+
21+
First, you need dependencies in your POM/Gradle:
22+
23+
```xml
24+
<dependency>
25+
<groupId>org.springframework.integration</groupId>
26+
<artifactId>spring-integration-core</artifactId>
27+
</dependency>
28+
```
29+
30+
which is also pulled transitively if you deal with target protocol channel adapters.
31+
For example for Apache Kafka support you need just this:
32+
33+
```xml
34+
<dependency>
35+
<groupId>org.springframework.integration</groupId>
36+
<artifactId>spring-integration-kafka</artifactId>
37+
</dependency>
38+
```
39+
40+
For annotations or Java DSL configuration you need to *enable* Spring Integration in the application context:
41+
42+
```java
43+
@EnableIntegration
44+
@Configuration
45+
public class ExampleConfiguration {
46+
47+
}
48+
```
49+
450
# Code of Conduct
551

652
Please see our [Code of conduct](https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md).
@@ -9,6 +55,11 @@ Please see our [Code of conduct](https://github.com/spring-projects/.github/blob
955

1056
Please see our [Security policy](https://github.com/spring-projects/spring-integration/security/policy).
1157

58+
# Documentation
59+
60+
The Spring Integration maintains reference documentation ([published](https://docs.spring.io/spring-integration/docs/current/reference/html/) and [source](src/reference/asciidoc)), GitHub [wiki pages](https://github.com/spring-projects/spring-integration/wiki), and an [API reference](https://docs.spring.io/spring-integration/docs/current/api/).
61+
There are also [guides and tutorials](https://spring.io/guides) across Spring projects.
62+
1263

1364
# Checking out and Building
1465

0 commit comments

Comments
 (0)