starred/sharpcompress
1
0
Fork 0
mirror of https://github.com/adamhathcock/sharpcompress.git synced 2026-04-05 21:51:09 +00:00
Code Issues 975 Packages Projects Releases 25 Wiki Activity

update docs

Browse Source
This commit is contained in:
Adam Hathcock
2026-03-03 12:50:27 +00:00
parent 0910f20c90
commit 3fb7e02653
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/API.md
View File

@@ -231,11 +231,11 @@ using (var writer = WriterFactory.OpenWriter(stream, ArchiveType.Zip, Compressio
### ReaderOptions
Use factory presets and fluent helpers for common configurations:
Use preset properties and fluent helpers for common configurations:
```csharp
// External stream with password and custom encoding
var options = ReaderOptions.ForExternalStream()
var options = ReaderOptions.ForExternalStream
.WithPassword("password")
.WithArchiveEncoding(new ArchiveEncoding { Default = Encoding.GetEncoding(932) });

4
src/SharpCompress/Readers/ReaderOptions.cs
View File

@@ -10,9 +10,9 @@ namespace SharpCompress.Readers;
/// Options for configuring reader behavior when opening archives.
/// </summary>
/// <remarks>
/// This class is immutable. Use factory presets and fluent helpers for common configurations:
/// This class is immutable. Use preset properties and fluent helpers for common configurations:
/// <code>
/// var options = ReaderOptions.ForExternalStream()
/// var options = ReaderOptions.ForExternalStream
/// .WithPassword("secret")
/// .WithLookForHeader(true);
/// </code>