Skip to content

Commit 8718089

Browse files
committed
Update README.md
1 parent 288b63e commit 8718089

File tree

1 file changed

+37
-33
lines changed

1 file changed

+37
-33
lines changed

README.md

+37-33
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,49 @@
11
Spring Batch Extensions
22
=============================
33

4-
The Spring Batch Extensions project provides extension modules for the [Spring Batch Project][]. This project is part of the [Spring organization][] on GitHub.
4+
The Spring Batch Extensions project provides extension modules for the [Spring Batch Project][].
5+
This project is part of the [Spring organization][] on GitHub.
56

67
## Available Modules
78

8-
9-
## Samples
10-
11-
Under the `samples` directory, you will find samples for the various modules. Please refer to the documentation of each sample for further details.
9+
| Module | Description | Lead |
10+
| -------|-------------| -----|
11+
| spring-batch-excel | Support for [Microsoft Excel] | @mdeinum |
12+
| spring-batch-elasticsearch | Support for [Elasticsearch] | TBA |
1213

1314
## Getting support
1415

15-
Check out the [spring-batch][spring-batch tag] tag
16-
on [Stack Overflow][]. [Commercial support][] is available too.
16+
Check out the [spring-batch][spring-batch tag] tag on Stack Overflow.
1717

1818
## Related GitHub projects
1919

2020
* [Spring Batch][]
21-
* [Spring Batch Admin][]
22-
* [Spring XD][]
23-
* [Spring for Apache Hadoop][]
2421
* [Spring Boot][]
22+
* [Spring Cloud Task][]
23+
* [Spring Cloud Data Flow][]
2524

2625
## Issue Tracking
2726

2827
Report issues via the Spring Batch Extensions [GitHub Issue Tracker][].
2928

3029
## Building from source
3130

32-
Each module of the *Spring Batch Extensions* project is hosted as independent project with its own release cycle. For the build process of individual modules we recomend using a [Maven][] build system modelled after the [Spring Batch][] project.
33-
34-
Therefore, the following build instructions should generally apply for most, if not all, *Spring Batch Extensions*. In the instructions below, `mvn` is invoked from the root of the source tree and serves as a cross-platform, self-contained bootstrap mechanism for the build. The only prerequisites are [Git][] and JDK 1.6+.
31+
Each module of the *Spring Batch Extensions* project is hosted as an independent project with its own release cycle.
32+
All modules are built with [Maven][]. The only prerequisites are [Git][] and JDK 1.8+.
3533

3634
### Check out the sources
3735

3836
`git clone git://github.com/spring-projects/spring-batch-extensions.git`
3937

4038
### Go into the directory of a specific module
4139

42-
`cd spring-batch-extensions`
43-
44-
`cd module-name`
40+
`cd spring-batch-extensions/module-name`
4541

4642
### Compile and test, build all jars
4743

4844
`mvn clean package`
4945

50-
### Install the modules jars into your local Maven cache
46+
### Install the modules jars into your local Maven repository
5147

5248
`mvn install`
5349

@@ -59,7 +55,7 @@ When using [Spring Tool Suite] you can directly import Maven based projects:
5955

6056
`File -> Import -> Maven Project`
6157

62-
Alternatively, you can also generate the Eclipse metadata (.classpath and .project files) using Maven:
58+
Alternatively, you can generate the Eclipse metadata (.classpath and .project files) using Maven:
6359

6460
`mvn eclipse:eclipse`
6561

@@ -69,9 +65,15 @@ Once complete, you may then import the projects into Eclipse as usual:
6965

7066
### Using IntelliJ IDEA
7167

72-
To generate IDEA metadata (.iml and .ipr files), do the following:
68+
When using [Intellij IDEA] you can directly import Maven based projects:
69+
70+
`File -> Open` then select the directory of the module.
71+
72+
Alternatively, you can generate the Intellij IDEA metadata (.iml and .ipr files) using Maven:
73+
74+
`mvn idea:idea`
7375

74-
mvn idea:idea
76+
Once complete, you may then import the projects into Intellij IDEA as usual.
7577

7678
## Contributing
7779

@@ -82,28 +84,30 @@ To generate IDEA metadata (.iml and .ipr files), do the following:
8284
Follow the Spring Batch team members and contributors on Twitter:
8385

8486
* [@michaelminella](https://twitter.com/michaelminella) - Michael Minella
85-
* [@chrisjs01](https://twitter.com/chrisjs01) - Chris Schaefer
87+
* [@b_e_n_a_s](https://twitter.com/b_e_n_a_s) - Mahmoud Ben Hassine
88+
* [@mdeinum](https://twitter.com/mdeinum) - Marten Deinum
8689

8790
## License
8891

89-
The Spring Batch Extensions Framework is released under version 2.0 of the [Apache License][] unless noted differently for individual extension Modules, but this should be the rare exception.
92+
The Spring Batch Extensions are released under version 2.0 of the [Apache License][] unless
93+
noted differently for individual extension Modules, but this should be the rare exception.
9094

9195
**We look forward to your contributions!!**
9296

93-
[Spring Batch]: https://github.com/spring-projects/spring-batch
9497
[Spring Batch Project]: https://projects.spring.io/spring-batch/
9598
[Spring organization]: https://github.com/spring-projects
99+
[Microsoft Excel]: https://www.microsoft.com/en-us/microsoft-365/excel
100+
[Elasticsearch]: https://www.elastic.co
96101
[spring-batch tag]: https://stackoverflow.com/questions/tagged/spring-batch
97-
[Stack Overflow]: https://stackoverflow.com/faq
98-
[Commercial support]: https://www.vmware.com/support/services/vfabric-developer.html
102+
[Spring Batch]: https://github.com/spring-projects/spring-batch
103+
[Spring Boot]: https://github.com/spring-projects/spring-boot
104+
[Spring Cloud Task]: https://github.com/spring-cloud/spring-cloud-task
105+
[Spring Cloud Data Flow]: https://github.com/spring-cloud/spring-cloud-dataflow
99106
[GitHub Issue Tracker]: https://github.com/spring-projects/spring-batch-extensions/issues
107+
[Maven]: https://maven.apache.org
100108
[Git]: https://help.github.com/set-up-git-redirect
101-
[Pull requests]: https://help.github.com/send-pull-requests
102-
[Spring Batch Admin]: https://github.com/spring-projects/spring-batch-admin
103-
[Spring XD]: https://github.com/spring-projects/spring-xd
104-
[Spring for Apache Hadoop]: https://github.com/spring-projects/spring-hadoop
105-
[Spring Boot]: https://github.com/spring-projects/spring-boot
106-
[Spring Tool Suite]: https://spring.io/tools/sts
109+
[Spring Tool Suite]: https://spring.io/tools
110+
[Intellij IDEA]: https://www.jetbrains.com/idea/
111+
[Pull requests]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
112+
[Contributor Guidelines]: CONTRIBUTING.md
107113
[Apache License]: https://www.apache.org/licenses/LICENSE-2.0
108-
[Maven]: https://maven.apache.org
109-
[Contributor Guidelines]: com/spring-projects/spring-batch-extensions/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)