Skip to content

Commit 8ea22ef

Browse files
committed
Update README
1 parent be4b6bc commit 8ea22ef

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/Ramstack.FileSystem.Zip/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@
44

55
Provides an implementation of `Ramstack.FileSystem` based on ZIP archives.
66

7+
> [!CAUTION]
8+
> The `ZipFileSystem` is **not thread-safe** and allows reading only one file at a time, as it relies on `ZipArchive`,
9+
> which does not support parallel read operations or simultaneous opening of multiple streams.
10+
11+
> [!WARNING]
12+
> Due to this limitation, the `ZipFileSystem` class is marked as `[Obsolete]`.
13+
14+
> [!IMPORTANT]
15+
> You may use `ZipFileSystem` only if you can guarantee that:
16+
> - Only one file is open for reading at a time.
17+
> - No file is accessed concurrently.
18+
719
## Getting Started
820

921
To install the `Ramstack.FileSystem.Zip` [NuGet package](https://www.nuget.org/packages/Ramstack.FileSystem.Zip)

0 commit comments

Comments
 (0)