diff --git a/README.md b/README.md index 9a16dfd..ba9969f 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,17 @@ If you miss some feature or have questions, do not hesitate to [open an issue][i Packages -------- -| Name | NuGet Package | Documentation | -|-----------------------|-------------------------------------------------------------------------------------------------|-------------------------------------------| -| **TruePath** | [![TruePath on nuget.org][nuget.badge.true-path]][nuget.true-path] | [API Reference][docs.true-path] | -| **TruePath.SystemIo** | [![TruePath.SystemIo on nuget.org][nuget.badge.true-path.system-io]][nuget.true-path.system-io] | [API Reference][docs.true-path.system-io] | +| Name | NuGet Package | Documentation | +|-----------------------|-------------------------------------------------------------------------------------------------|--------------------------------------------| +| **TruePath** | [![TruePath on nuget.org][nuget.badge.true-path]][nuget.true-path] | [API Reference][docs.true-path] | +| **TruePath.SystemIo** | [![TruePath.SystemIo on nuget.org][nuget.badge.true-path.system-io]][nuget.true-path.system-io] | [API Reference][docs.true-path.system-io] | +| **TruePath.TestableIO.System.IO** (third-party) | [![TruePath.TestableIO.System.IO on nuget.org][nuget.badge.true-path.testableio.system-io]][nuget.true-path.testableio.system-io] | [Documentation][github.true-path.testable-io] | TruePath provides two NuGet packages: - [**TruePath**][nuget.true-path] for the main path abstractions, -- [**TruePath.SystemIo**][nuget.true-path.system-io] for the `System.IO` integration. +- [**TruePath.SystemIo**][nuget.true-path.system-io] for the `System.IO` integration. + +A third-party package, [**TruePath.TestableIO.System.IO**][nuget.true-path.testableio.system-io], adds [TestableIO.System.IO.Abstractions][testable-io.system.io.abstractions] integration on top of TruePath. Documentation ------------- @@ -55,12 +58,16 @@ The license indication in the project's sources is compliant with the [REUSE spe [docs.true-path.system-io]: https://fornever.github.io/TruePath/api/TruePath.SystemIo.html [docs.true-path]: https://fornever.github.io/TruePath/api/TruePath.html [docs]: https://fornever.github.io/TruePath +[github.true-path.testable-io]: https://github.com/jeppevammenkristensen/FileBasedApp.Toolkit/blob/main/Source/TruePath.TestableIO.System.IO/README.md [issues]: https://github.com/ForNeVeR/TruePath/issues [java.path]: https://docs.oracle.com/en%2Fjava%2Fjavase%2F21%2Fdocs%2Fapi%2F%2F/java.base/java/nio/file/Path.html [kotlin.path]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io.path/java.nio.file.-path/ [nuget.badge.true-path.system-io]: https://img.shields.io/nuget/v/TruePath.SystemIo +[nuget.badge.true-path.testableio.system-io]: https://img.shields.io/nuget/v/TruePath.TestableIO.System.IO [nuget.badge.true-path]: https://img.shields.io/nuget/v/TruePath [nuget.true-path.system-io]: https://www.nuget.org/packages/TruePath.SystemIo +[nuget.true-path.testableio.system-io]: https://www.nuget.org/packages/TruePath.TestableIO.System.IO/ [nuget.true-path]: https://www.nuget.org/packages/TruePath [reuse.spec]: https://reuse.software/spec-3.3/ [status-ventis]: https://img.shields.io/badge/status-ventis-yellow.svg +[testable-io.system.io.abstractions]: https://github.com/TestableIO/System.IO.Abstractions \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index f738cfe..52ee02e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,6 +37,8 @@ TruePath provides two packages: - [TruePath][nuget.true-path] for path abstractions, - [TruePath.SystemIo][nuget.true-path.system-io] for the `System.IO` integration. +A third-party package, [TruePath.TestableIO.System.IO][nuget.true-path.testable-io.system-io], which adds [TestableIO.System.IO.Abstractions][testable-io.system.io.abstractions] integration on top of TruePath. + Usage ----- The library offers several struct (i.e. low to zero memory overhead) types wrapping path strings. The types are designed to not involve any disk IO operations by default, and thus provide excellent performance during common operations. This comes with a drawback, though: **path comparison is only performed as string comparison so far** — though it tries to take platform-specific case sensitivity defaults into account. See the section **Path Comparison** for details. @@ -120,4 +122,6 @@ To convert the path to the canonical form, use `AbsolutePath::Canonicalize`. [java.path]: https://docs.oracle.com/en%2Fjava%2Fjavase%2F21%2Fdocs%2Fapi%2F%2F/java.base/java/nio/file/Path.html [kotlin.path]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io.path/java.nio.file.-path/ [nuget.true-path.system-io]: https://www.nuget.org/packages/TruePath.SystemIo +[nuget.true-path.testable-io.system-io]: https://www.nuget.org/packages/TruePath.TestableIO.System.IO/ [nuget.true-path]: https://www.nuget.org/packages/TruePath +[testable-io.system.io.abstractions]: https://github.com/TestableIO/System.IO.Abstractions \ No newline at end of file