Skip to content

Commit

Permalink
[ci-skip] Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Kaoticz committed Dec 30, 2024
1 parent e739d17 commit b28e1f0
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Kotz.Utilities/Kotz.Utilities.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</PropertyGroup>

<ItemGroup>
<None Include="..\README.md">
<None Include="README.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
Expand Down
16 changes: 16 additions & 0 deletions Kotz.Utilities/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Kotz.Utilities

Defines the following types:

- **KotzUtilities**: static class with a wide range of helper methods.
- AddPathToPATHEnvar: Adds a directory path to the PATH environment variable.
- HasWritePermissionAt: Checks if this application can write to the specified directory.
- ProgramExists: Checks if a program exists at the specified absolute path or the PATH environment variable.
- StartProcess: Starts the specified program in the background.
- TryCreate: Safely creates an object with the specified factory method.
- TryDeleteFSO: Safely deletes a file or directory.
- TryDeleteFile: Safely deletes a file.
- TryDeleteDirectory: Safely deletes a directory.
- TryMoveFSO: Safely moves a file or directory.
- TryMoveFile: Safely moves a file.
- TryMoveDirectory: Safely moves a directory.
57 changes: 44 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,47 @@
[![.NET Unit Tests][.NET-Badge]][.NET-Url]
[![CodeQL][CodeQL-Badge]][CodeQL-Url]
[![CodeFactor][CodeFactor-Badge]][CodeFactor-Url]
[![NuGet Badge][Nuget-Badge]][Nuget-Url]
[![NuGet Nightly Badge][Nuget-Nightly-Badge]][Nuget-Url]

# Kotz.Utilities

Defines the following types:
General C# utilities commonly used on projects I work on.

Currently contains:
- [![Kotz.Utilities-NuGet Downloads][Kotz.Utilities-Nuget-Downloads]][Kotz.Utilities-Nuget-Url] [Kotz.Utilities]
- [![Kotz.Collections-NuGet Downloads][Kotz.Collections-Nuget-Downloads]][Kotz.Collections-Nuget-Url] [Kotz.Collections]
- [![Kotz.DependencyInjection-NuGet Downloads][Kotz.DependencyInjection-Nuget-Downloads]][Kotz.DependencyInjection-Nuget-Url] [Kotz.DependencyInjection]
- [![Kotz.Events-NuGet Downloads][Kotz.Events-Nuget-Downloads]][Kotz.Events-Nuget-Url] [Kotz.Events]
- [![Kotz.Extensions-NuGet Downloads][Kotz.Extensions-Nuget-Downloads]][Kotz.Extensions-Nuget-Url] [Kotz.Extensions]
- [![Kotz.ObjectPool-NuGet Downloads][Kotz.ObjectPool-Nuget-Downloads]][Kotz.ObjectPool-Nuget-Url] [Kotz.ObjectPool]


[Kotz.Collections]: ./Kotz.Collections/README.md
[Kotz.DependencyInjection]: ./Kotz.DependencyInjection/README.md
[Kotz.Events]: ./Kotz.Events/README.md
[Kotz.Extensions]: ./Kotz.Extensions/README.md
[Kotz.ObjectPool]: ./Kotz.ObjectPool/README.md
[Kotz.Utilities]: ./Kotz.Utilities/README.md
[CodeFactor-Url]: https://www.codefactor.io/repository/github/kaoticz/kotz.utilities/overview/main
[CodeFactor-Badge]: https://www.codefactor.io/repository/github/kaoticz/kotz.utilities/badge/main
[.NET-Url]: ../../actions/workflows/dotnet.yml
[.NET-Badge]: ../../actions/workflows/dotnet.yml/badge.svg
[CodeQL-Url]: ../../actions/workflows/codeql-analysis.yml
[CodeQL-Badge]: ../../actions/workflows/codeql-analysis.yml/badge.svg
[Nuget-Badge]: https://img.shields.io/nuget/v/Kotz.Utilities.svg?label=NuGet
[Nuget-Nightly-Badge]: https://img.shields.io/nuget/vpre/Kotz.Utilities?color=00007f&label=NuGet%20Nightly
[Nuget-Url]: https://www.nuget.org/packages/Kotz.Utilities

- **KotzUtilities**: static class with a wide range of helper methods.
- AddPathToPATHEnvar: Adds a directory path to the PATH environment variable.
- HasWritePermissionAt: Checks if this application can write to the specified directory.
- ProgramExists: Checks if a program exists at the specified absolute path or the PATH environment variable.
- StartProcess: Starts the specified program in the background.
- TryCreate: Safely creates an object with the specified factory method.
- TryDeleteFSO: Safely deletes a file or directory.
- TryDeleteFile: Safely deletes a file.
- TryDeleteDirectory: Safely deletes a directory.
- TryMoveFSO: Safely moves a file or directory.
- TryMoveFile: Safely moves a file.
- TryMoveDirectory: Safely moves a directory.
[Kotz.Collections-Nuget-Downloads]: https://img.shields.io/nuget/dt/Kotz.Collections?color=00aa00
[Kotz.Collections-Nuget-Url]: https://www.nuget.org/packages/Kotz.Collections
[Kotz.Extensions-Nuget-Downloads]: https://img.shields.io/nuget/dt/Kotz.Extensions?color=00aa00
[Kotz.Extensions-Nuget-Url]: https://www.nuget.org/packages/Kotz.Extensions
[Kotz.ObjectPool-Nuget-Downloads]: https://img.shields.io/nuget/dt/Kotz.ObjectPool?color=00aa00
[Kotz.ObjectPool-Nuget-Url]: https://www.nuget.org/packages/Kotz.ObjectPool
[Kotz.Events-Nuget-Downloads]: https://img.shields.io/nuget/dt/Kotz.Events?color=00aa00
[Kotz.Events-Nuget-Url]: https://www.nuget.org/packages/Kotz.Events
[Kotz.DependencyInjection-Nuget-Downloads]: https://img.shields.io/nuget/dt/Kotz.DependencyInjection?color=00aa00
[Kotz.DependencyInjection-Nuget-Url]: https://www.nuget.org/packages/Kotz.DependencyInjection
[Kotz.Utilities-Nuget-Downloads]: https://img.shields.io/nuget/dt/Kotz.Utilities?color=00aa00
[Kotz.Utilities-Nuget-Url]: https://www.nuget.org/packages/Kotz.Utilities

0 comments on commit b28e1f0

Please sign in to comment.