Skip to content

Commit 54bb505

Browse files
committed
Docs: add information about TruePath.TestableIO.System.IO
1 parent 748aac3 commit 54bb505

2 files changed

Lines changed: 12 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,16 @@ If you miss some feature or have questions, do not hesitate to [open an issue][i
2424

2525
Packages
2626
--------
27-
| Name | NuGet Package | Documentation |
28-
|-----------------------|-------------------------------------------------------------------------------------------------|-------------------------------------------|
29-
| **TruePath** | [![TruePath on nuget.org][nuget.badge.true-path]][nuget.true-path] | [API Reference][docs.true-path] |
30-
| **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] |
27+
| Name | NuGet Package | Documentation |
28+
|-----------------------|-------------------------------------------------------------------------------------------------|--------------------------------------------|
29+
| **TruePath** | [![TruePath on nuget.org][nuget.badge.true-path]][nuget.true-path] | [API Reference][docs.true-path] |
30+
| **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] |
31+
| **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] |
3132

3233
TruePath provides two NuGet packages:
3334
- [**TruePath**][nuget.true-path] for the main path abstractions,
3435
- [**TruePath.SystemIo**][nuget.true-path.system-io] for the `System.IO` integration.
36+
- A third-party package, [**TruePath.TestableIO.System.IO**][nuget.true-path.testableio.system-io], adds `TestableIO.System.IO` integration on top of `TruePath.SystemIo`.
3537

3638
Documentation
3739
-------------
@@ -55,12 +57,15 @@ The license indication in the project's sources is compliant with the [REUSE spe
5557
[docs.true-path.system-io]: https://fornever.github.io/TruePath/api/TruePath.SystemIo.html
5658
[docs.true-path]: https://fornever.github.io/TruePath/api/TruePath.html
5759
[docs]: https://fornever.github.io/TruePath
60+
[github.true-path.testable-io]: https://github.com/jeppevammenkristensen/FileBasedApp.Toolkit/blob/main/Source/TruePath.TestableIO.System.IO/README.md
5861
[issues]: https://github.com/ForNeVeR/TruePath/issues
5962
[java.path]: https://docs.oracle.com/en%2Fjava%2Fjavase%2F21%2Fdocs%2Fapi%2F%2F/java.base/java/nio/file/Path.html
6063
[kotlin.path]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io.path/java.nio.file.-path/
6164
[nuget.badge.true-path.system-io]: https://img.shields.io/nuget/v/TruePath.SystemIo
65+
[nuget.badge.true-path.testableio.system-io]: https://img.shields.io/nuget/v/TruePath.TestableIO.System.IO
6266
[nuget.badge.true-path]: https://img.shields.io/nuget/v/TruePath
6367
[nuget.true-path.system-io]: https://www.nuget.org/packages/TruePath.SystemIo
68+
[nuget.true-path.testableio.system-io]: https://www.nuget.org/packages/TruePath.TestableIO.System.IO/
6469
[nuget.true-path]: https://www.nuget.org/packages/TruePath
6570
[reuse.spec]: https://reuse.software/spec-3.3/
66-
[status-ventis]: https://img.shields.io/badge/status-ventis-yellow.svg
71+
[status-ventis]: https://img.shields.io/badge/status-ventis-yellow.svg

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Packages
3636
TruePath provides two packages:
3737
- [TruePath][nuget.true-path] for path abstractions,
3838
- [TruePath.SystemIo][nuget.true-path.system-io] for the `System.IO` integration.
39+
- A third-party package, [TruePath.TestableIO.System.IO][nuget.true-path.testable-io.system-io], adds `TestableIO.System.IO` integration on top of `TruePath.SystemIo`.
3940

4041
Usage
4142
-----
@@ -120,4 +121,5 @@ To convert the path to the canonical form, use `AbsolutePath::Canonicalize`.
120121
[java.path]: https://docs.oracle.com/en%2Fjava%2Fjavase%2F21%2Fdocs%2Fapi%2F%2F/java.base/java/nio/file/Path.html
121122
[kotlin.path]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io.path/java.nio.file.-path/
122123
[nuget.true-path.system-io]: https://www.nuget.org/packages/TruePath.SystemIo
124+
[nuget.true-path.testable-io.system-io]: https://www.nuget.org/packages/TruePath.TestableIO.System.IO/
123125
[nuget.true-path]: https://www.nuget.org/packages/TruePath

0 commit comments

Comments
 (0)