Add performance hints
Change-Id: Ie7ac6e9e1a17da9d50447146566491018ae7108b
diff --git a/Changes b/Changes
index 837c1f7..5914da4 100644
--- a/Changes
+++ b/Changes
@@ -1,5 +1,6 @@
0.58 2024-09-11
- Remove Directory::Iterator and replace it with Mojo::File.
+ - Add performance hint.
0.57 2024-07-26
- Support award notes in i5.
diff --git a/Readme.pod b/Readme.pod
index 44dff3f..6939e32 100644
--- a/Readme.pod
+++ b/Readme.pod
@@ -369,6 +369,28 @@
=back
+=head1 PERFORMANCE
+
+There are some ways to improve performance for large tasks:
+
+=item First unpack
+
+Using the archive or serial command on one or multiple zip files
+can be very slow, as it needs to unpack small portions every time.
+It's better to use C<--temporary-extract> to unpack the whole archive
+first into a temprary directory and then read the extracted files.
+This is especially important for remote archives
+
+=item Limit annotations
+
+Per default, all supported annotation layers are sought. This can be limited
+by adding C<--skip '#ALL'> and only listing the expected annotations with C<--anno>.
+
+=item Checking the parallel job count
+
+By providing the number of parallel jobs using C<--jobs>, the execution can be tailored to specific
+hardware environments.
+
=head1 ANNOTATION SUPPORT
diff --git a/script/korapxml2krill b/script/korapxml2krill
index f67b8b5..30f3384 100755
--- a/script/korapxml2krill
+++ b/script/korapxml2krill
@@ -1479,6 +1479,28 @@
=back
+=head1 PERFORMANCE
+
+There are some ways to improve performance for large tasks:
+
+=item First unpack
+
+Using the archive or serial command on one or multiple zip files
+can be very slow, as it needs to unpack small portions every time.
+It's better to use C<--temporary-extract> to unpack the whole archive
+first into a temprary directory and then read the extracted files.
+This is especially important for remote archives
+
+=item Limit annotations
+
+Per default, all supported annotation layers are sought. This can be limited
+by adding C<--skip '#ALL'> and only listing the expected annotations with C<--anno>.
+
+=item Checking the parallel job count
+
+By providing the number of parallel jobs using C<--jobs>, the execution can be tailored to specific
+hardware environments.
+
=head1 ANNOTATION SUPPORT
L<KorAP::XML::Krill> has built-in importer for some annotation foundries and layers