Skip to content

Conversation

@feO2x
Copy link
Owner

@feO2x feO2x commented Jul 10, 2025

This pull request updates the readme.md file to improve clarity, fix grammatical issues, and enhance the documentation for the Light.TemporaryStreams library. The changes include rewording descriptions, updating examples, and refining usage scenarios.

Documentation Improvements:

  • Simplified and clarified the library's overview, removing redundant phrases and improving readability.
  • Updated the example in the SomeService class to use asynchronous methods, added a CancellationToken parameter where applicable, and improved comments for better understanding.
  • Fixed grammatical issues and improved phrasing in the explanation of the HashingPlugin functionality.

Usage Scenarios:

  • Enhanced the "When To Use Light.TemporaryStreams" section by refining descriptions and adding a new scenario for returning a stream that should be deleted after the request.

When to use Information:

  • Updated the description of Light.TemporaryStreams to include integration with Microsoft.Extensions.Logging.

feO2x added 3 commits July 9, 2025 20:45
Signed-off-by: Kenny Pflug <kenny.pflug@live.de>
Signed-off-by: Kenny Pflug <kenny.pflug@live.de>
@feO2x feO2x self-assigned this Jul 10, 2025
@feO2x feO2x added the documentation Improvements or additions to documentation label Jul 10, 2025
@feO2x feO2x requested a review from Copilot July 10, 2025 03:42
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refines the readme.md documentation by improving clarity, fixing grammatical errors, and enhancing usage examples for the Light.TemporaryStreams library.

  • Simplified and reworded the overview and key features for readability.
  • Updated SomeService example to use asynchronous methods with CancellationToken.
  • Refined usage scenarios and added a new scenario for streams that auto-delete after request.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@feO2x feO2x merged commit e6dc738 into main Jul 10, 2025
1 check passed
@feO2x feO2x deleted the readme-updates branch July 10, 2025 03:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants