From 8718089003fb39136eb9dc7562a2ab9c51639685 Mon Sep 17 00:00:00 2001 From: Mahmoud Ben Hassine Date: Wed, 3 Mar 2021 09:25:55 +0100 Subject: [PATCH] Update README.md --- README.md | 72 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 38 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index cc55c77..8c36fb0 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,26 @@ Spring Batch Extensions ============================= -The Spring Batch Extensions project provides extension modules for the [Spring Batch Project][]. This project is part of the [Spring organization][] on GitHub. +The Spring Batch Extensions project provides extension modules for the [Spring Batch Project][]. +This project is part of the [Spring organization][] on GitHub. ## Available Modules - -## Samples - -Under the `samples` directory, you will find samples for the various modules. Please refer to the documentation of each sample for further details. +| Module | Description | Lead | +| -------|-------------| -----| +| spring-batch-excel | Support for [Microsoft Excel] | @mdeinum | +| spring-batch-elasticsearch | Support for [Elasticsearch] | TBA | ## Getting support -Check out the [spring-batch][spring-batch tag] tag -on [Stack Overflow][]. [Commercial support][] is available too. +Check out the [spring-batch][spring-batch tag] tag on Stack Overflow. ## Related GitHub projects * [Spring Batch][] -* [Spring Batch Admin][] -* [Spring XD][] -* [Spring for Apache Hadoop][] * [Spring Boot][] +* [Spring Cloud Task][] +* [Spring Cloud Data Flow][] ## Issue Tracking @@ -29,9 +28,8 @@ Report issues via the Spring Batch Extensions [GitHub Issue Tracker][]. ## Building from source -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. - -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+. +Each module of the *Spring Batch Extensions* project is hosted as an independent project with its own release cycle. +All modules are built with [Maven][]. The only prerequisites are [Git][] and JDK 1.8+. ### Check out the sources @@ -39,15 +37,13 @@ Therefore, the following build instructions should generally apply for most, if ### Go into the directory of a specific module -`cd spring-batch-extensions` - -`cd module-name` +`cd spring-batch-extensions/module-name` ### Compile and test, build all jars `mvn clean package` -### Install the modules jars into your local Maven cache +### Install the modules jars into your local Maven repository `mvn install` @@ -59,7 +55,7 @@ When using [Spring Tool Suite] you can directly import Maven based projects: `File -> Import -> Maven Project` -Alternatively, you can also generate the Eclipse metadata (.classpath and .project files) using Maven: +Alternatively, you can generate the Eclipse metadata (.classpath and .project files) using Maven: `mvn eclipse:eclipse` @@ -69,9 +65,15 @@ Once complete, you may then import the projects into Eclipse as usual: ### Using IntelliJ IDEA -To generate IDEA metadata (.iml and .ipr files), do the following: +When using [Intellij IDEA] you can directly import Maven based projects: - mvn idea:idea +`File -> Open` then select the directory of the module. + +Alternatively, you can generate the Intellij IDEA metadata (.iml and .ipr files) using Maven: + +`mvn idea:idea` + +Once complete, you may then import the projects into Intellij IDEA as usual. ## Contributing @@ -82,28 +84,30 @@ To generate IDEA metadata (.iml and .ipr files), do the following: Follow the Spring Batch team members and contributors on Twitter: * [@michaelminella](https://twitter.com/michaelminella) - Michael Minella -* [@chrisjs01](https://twitter.com/chrisjs01) - Chris Schaefer +* [@b_e_n_a_s](https://twitter.com/b_e_n_a_s) - Mahmoud Ben Hassine +* [@mdeinum](https://twitter.com/mdeinum) - Marten Deinum ## License -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. +The Spring Batch Extensions are released under version 2.0 of the [Apache License][] unless +noted differently for individual extension Modules, but this should be the rare exception. **We look forward to your contributions!!** -[Spring Batch]: https://github.com/spring-projects/spring-batch [Spring Batch Project]: https://projects.spring.io/spring-batch/ [Spring organization]: https://github.com/spring-projects +[Microsoft Excel]: https://www.microsoft.com/en-us/microsoft-365/excel +[Elasticsearch]: https://www.elastic.co [spring-batch tag]: https://stackoverflow.com/questions/tagged/spring-batch -[Stack Overflow]: https://stackoverflow.com/faq -[Commercial support]: https://www.vmware.com/support/services/vfabric-developer.html -[GitHub Issue Tracker]: https://github.com/spring-projects/spring-batch-extensions/issues -[Git]: https://help.github.com/set-up-git-redirect -[Pull requests]: https://help.github.com/send-pull-requests -[Spring Batch Admin]: https://github.com/spring-projects/spring-batch-admin -[Spring XD]: https://github.com/spring-projects/spring-xd -[Spring for Apache Hadoop]: https://github.com/spring-projects/spring-hadoop +[Spring Batch]: https://github.com/spring-projects/spring-batch [Spring Boot]: https://github.com/spring-projects/spring-boot -[Spring Tool Suite]: https://spring.io/tools/sts -[Apache License]: https://www.apache.org/licenses/LICENSE-2.0 +[Spring Cloud Task]: https://github.com/spring-cloud/spring-cloud-task +[Spring Cloud Data Flow]: https://github.com/spring-cloud/spring-cloud-dataflow +[GitHub Issue Tracker]: https://github.com/spring-projects/spring-batch-extensions/issues [Maven]: https://maven.apache.org -[Contributor Guidelines]: com/spring-projects/spring-batch-extensions/blob/master/CONTRIBUTING.md +[Git]: https://help.github.com/set-up-git-redirect +[Spring Tool Suite]: https://spring.io/tools +[Intellij IDEA]: https://www.jetbrains.com/idea/ +[Pull requests]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests +[Contributor Guidelines]: CONTRIBUTING.md +[Apache License]: https://www.apache.org/licenses/LICENSE-2.0