Add to readme

Author: kiendang

Readme.adoc

@@ -1233,7 +1233,8 @@ def apply(dest: os.Path,
           includePatterns: Seq[Regex] = List(),
           preserveMtimes: Boolean = false,
           deletePatterns: Seq[Regex] = List(),
-          compressionLevel: Int = -1 /* 0-9 */): os.Path
+          compressionLevel: Int = -1, /* 0-9 */
+          followLinks: Boolean = true): os.Path
 ----
 
 The zip object provides functionality to create or modify zip archives. It supports:
@@ -1243,14 +1244,19 @@ The zip object provides functionality to create or modify zip archives. It suppo
 - Exclude Patterns (-x): You can specify files or patterns to exclude while zipping.
 - Include Patterns (-i): You can include specific files or patterns while zipping.
 - Delete Patterns (-d): You can delete specific files from an existing zip archive.
-- Configuring whether or not to preserve filesyste mtimes and permissions
+- Symbolic Links (-y): You can configure to zip symbolic links as the referenced files, which is the default, or as symbolic links, by setting `followLinks = false`.
+- Configuring whether or not to preserve filesyste mtimes.
+- Preserving Unix file permissions.
 
 This will create a new zip archive at `dest` containing `file1.txt` and everything
 inside `sources`. If `dest` already exists as a zip, the files will be appended to the
 existing zip, and any existing zip entries matching `deletePatterns` will be removed.
 
-Note that `os.zip` doesn't support creating/unpacking symlinks or filesystem permissions
-in Zip files, because the underlying `java.util.zip.Zip*Stream` doesn't support them.
+When modifying an existing zip file,
+- Unix file permissions will be preserved if Java Runtime Version >= 14.
+- If using Java Runtime Version < 14, Unix file permissions are not preserved, even for existing zip entries.
+- Symbolics links will always be stored as the referenced files.
+- Existing symbolic links stored in the zip might lose their symbolic link file type field and become broken.
 
 ===== Zipping Files and Folders
 
@@ -1375,6 +1381,8 @@ assert(paths == Seq(unzippedFolder / "File.txt"))
 This can be useful for streaming the zipped data to places which are not files:
 over the network, over a pipe, etc.
 
+File permissions will be preserved. By default, symbolic links will be zipped as the referenced files. Set `followLinks = false` to zip them as symbolic links.
+
 ==== `os.unzip`
 
 ===== Unzipping Files
@@ -1384,7 +1392,7 @@ over the network, over a pipe, etc.
 os.unzip(os.Path("/path/to/archive.zip"), Some(os.Path("/path/to/destination")))
 ----
 
-This extracts the contents of `archive.zip` to the specified destination.
+This extracts the contents of `archive.zip` to the specified destination. It supports preserving file permissions and symbolic links.
 
 
 ===== Excluding Files While Unzipping
@@ -1407,7 +1415,7 @@ You can list the contents of the zip file without extracting them:
 os.unzip.list(os.Path("/path/to/archive.zip"))
 ----
 
-This will print all the file paths contained in the zip archive.
+This will print all the file paths contained in the zip archive. File permissions and symbolic links will not be preserved.
 
 ==== `os.unzip.stream`
 
@@ -1464,6 +1472,8 @@ finally zipFile3.close()
 of the zip file rather than a bare path on the filesystem. Note that you need to call `ZipRoot#close()`
 when you are done with it to avoid leaking filesystem resources.
 
+File permissions are only supported for Java Runtime Version >= 14. Symbolic links are not supported. Using `os.zip.open` on a zip archive that contains symbolic links might break the links.
+
 === Filesystem Metadata
 
 ==== `os.stat`
@@ -1793,7 +1803,7 @@ is run:
 
 * `cwd`: the working directory of the subprocess
 * `env`: any additional environment variables you wish to set in the subprocess
-  in addition to those passed via `propagateEnv`. You can also set their values 
+  in addition to those passed via `propagateEnv`. You can also set their values
   to `null` to remove specific variables.
 * `stdin`: any data you wish to pass to the subprocess's standard input
 * `stdout`/`stderr`: these are ``os.Redirect``s that let you configure how the