Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
kzdev-net committed Oct 12, 2024
2 parents 2d63711 + dc98456 commit f6af967
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 3 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,12 @@ This is the repository for the 'KZDev.PerfUtils' nuget package that contains the
## Future Features

The roadmap plan for this package is to add several additional helpful performance focused utilities. These will be forthcoming as time permits, so this first release is focused just on the `MemoryStreamSlim` class.

## Contribution Guidelines

At this time, I am not accepting external pull requests. However, any feedback or suggestions are welcome and can be provided through the following channels:

- **Feature Requests:** Please use GitHub Discussions to propose new features or enhancements.
- **Bug Reports:** If you encounter any issues, feel free to open an issue so it can be addressed promptly.

I appreciate your understanding and look forward to collaborating with you through discussions and issue tracking.
2 changes: 1 addition & 1 deletion Source/Docs/articles/memory-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This counter provides the number of buffer segments currently allocated from the

## Events

For detailed monitoring of `MemoryStreamSlim` instances and memory management, you can use the `EventSource` events that are provided by the `PerfUtils` library with tools such as [`PerfView`](#perfView-example). The event source name is `KZDev.PerfUtils`. The following events are available.
For detailed monitoring of `MemoryStreamSlim` instances and memory management, you can use the `EventSource` events that are provided by the `PerfUtils` library with tools such as [`PerfView`](#perfview-example). The event source name is `KZDev.PerfUtils`. The following events are available.

### MemoryStreamSlimCreate event

Expand Down
2 changes: 1 addition & 1 deletion Source/Docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ One other important difference is that `MemoryStreamSlim` is specifically design

## Documentation

Full documentation for the package is available on the [PerfUtils Documentation](./Docs/index.md) page.
Full documentation for the package is available on the [PerfUtils Documentation](articles/getting-started.md) page.

## Future Features

Expand Down
2 changes: 1 addition & 1 deletion Source/Src/KZDev.PerfUtils/Package/nuget.readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The `MemoryStreamSlim` class is similar in concept and purpose to the [`Recyclab

## Documentation

Full documentation for the package is available on the [PerfUtils Documentation](./Docs/index.md) page.
Full documentation for the package is available on the [PerfUtils Documentation](https://kzdev-net.github.io/kzdev.perfutils) page.

## Future Features

Expand Down

0 comments on commit f6af967

Please sign in to comment.