Skip to content

Commit

Permalink
(#76) Document the changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ForNeVeR committed Aug 11, 2024
1 parent e8cc4ce commit b32239f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- `AbsolutePath::Canonicalize` to convert the path to absolute, convert to correct case on case-insensitive file systems, resolve symlinks.

Thanks to @Kataane.
- [#76](https://github.com/ForNeVeR/TruePath/issues/76): a new `Temporary` class for creating a temp file or folder.

Thanks to @Illusion4.

## [1.3.0] - 2024-06-21
### Added
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,13 @@ Aside from the strict types, the following features are supported for the paths:

(Note how `GetFileNameWithoutExtension()` works nicely together with `GetExtensionWithDot()` to reconstruct the resulting path from their concatenation, however weird the initial name was — no extension, trailing dot, no base name.)

### `Temporary`

`TruePath.Temporary` class contains a set of utility methods to work with the system temp directory (most widely known as `TEMP` or `TMP` environment variable):
- `Temporary::SystemTempDirectory()` will return it as an absolute path;
- `Temporary::CreateTempFile()` will create a randomly-named file in the system temp directory and return an absolute path to it;
- `Temporary::CreateTempFolder()` will create a randomly-named folder in the system temp directory and return an absolute path to it.

Documentation
-------------
- [Contributor Guide][docs.contributing]
Expand Down

0 comments on commit b32239f

Please sign in to comment.