(incubator-stormcrawler) branch rel-stormcrawler-3.0-rc2 created (now 3f326295)

[rz...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rzo1 pushed a change to branch rel-stormcrawler-3.0-rc2
in repository https://gitbox.apache.org/repos/asf/incubator-stormcrawler.git


      at 3f326295 Update README to be compatible with release 3.0

This branch includes the following new commits:

     new 3f326295 Update README to be compatible with release 3.0

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

(incubator-stormcrawler) 01/01: Update README to be compatible with release 3.0

[rz...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rzo1 pushed a commit to branch rel-stormcrawler-3.0-rc2
in repository https://gitbox.apache.org/repos/asf/incubator-stormcrawler.git

commit 3f3262954fb9a474d20d6348ca99e2140202003f
Author: Richard Zowalla <rz...@apache.org>
AuthorDate: Mon May 6 20:18:04 2024 +0200

    Update README to be compatible with release 3.0
---
 README.md | 14 ++------------
 1 file changed, 2 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index d8e515ea..d0cb0189 100644
--- a/README.md
+++ b/README.md
@@ -12,19 +12,14 @@ Apache StormCrawler (Incubating) is an open source collection of resources for b
 
 NOTE: These instructions assume that you have [Apache Maven](https://maven.apache.org/install.html) installed. You will need to install [Apache Storm 2.6.2](http://storm.apache.org/) to run the crawler.
 
-StormCrawler requires Java 11 or above.
+StormCrawler requires Java 11 or above. To execute tests, it requires you to have a locally installed and working Docker environment.
 
 DigitalPebble's [Ansible-Storm](https://github.com/DigitalPebble/ansible-storm) repository contains resources to install Apache Storm using Ansible. Alternatively, this [stormcrawler-docker](https://github.com/DigitalPebble/stormcrawler-docker) project should help you run Apache Storm on Docker.
 
 Once Storm is installed, the easiest way to get started is to generate a new StormCrawler project following the instructions below: 
 
-### First, build the Stormcrawler codebase
 ```shell
-mvn install
-```
-### Then, generate a project using the locally installed archetype
-```shell
-mvn archetype:generate -DarchetypeGroupId=org.apache.stormcrawler -DarchetypeArtifactId=stormcrawler-archetype -DarchetypeVersion=3.0-SNAPSHOT
+mvn archetype:generate -DarchetypeGroupId=org.apache.stormcrawler -DarchetypeArtifactId=stormcrawler-archetype -DarchetypeVersion=3.0
 ```
 
 You'll be asked to enter a groupId (e.g. com.mycompany.crawler), an artefactId (e.g. stormcrawler), a version, a package name and details about the user agent to use.
@@ -35,11 +30,6 @@ Alternatively if you can't or don't want to use the Maven archetype above, you c
 
 Have a look at the code of the [CrawlTopology class](https://github.com/apache/incubator-stormcrawler/blob/master/archetype/src/main/resources/archetype-resources/src/main/java/CrawlTopology.java), the [crawler-conf.yaml](https://github.com/apache/incubator-stormcrawler/blob/master/archetype/src/main/resources/archetype-resources/crawler-conf.yaml) file as well as the files in [src/main/resources/](https://github.com/apache/incubator-stormcrawler/tree/master/archetype/src/main/resources/ [...]
 
-#### Archetype Notes
-
-While you will always be able to build StormCrawler from source we are working towards getting our first release out under the Apache Software Foundation.
-Once this happens, generating StormCrawler projects will not require you to install the Maven archetype from source.
-
 ## Getting help
 
 The [WIKI](https://github.com/apache/incubator-stormcrawler/wiki) is a good place to start your investigations but if you are stuck please use the tag [stormcrawler](http://stackoverflow.com/questions/tagged/stormcrawler) on StackOverflow or ask a question in the [discussions](https://github.com/apache/incubator-stormcrawler/discussions) section.