Skip to content

[Doc] Update documentation to reflect current public interface #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ipek
Copy link
Collaborator

@ipek ipek commented Jun 2, 2025

This pull request updates the README.md file to enhance documentation for networking operations, including downloading, uploading, retry mechanisms, and request modifiers. The changes aim to provide clearer examples and additional functionality for developers using the library.

Enhancements to Downloading and Uploading Documentation:

  • Updated examples for downloading files, including progress tracking and resumable downloads. Added support for retry configurations in download requests. ([README.mdL76-R131](https://github.com/strvcom/ios-networking/pull/75/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L76-R131))
  • Expanded uploading examples to include raw data uploads, multipart form data, and progress tracking. Introduced methods to track active upload tasks, retry failed uploads, and clean up resources. ([README.mdL76-R131](https://github.com/strvcom/ios-networking/pull/75/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L76-R131))

Retry Mechanism and Modifiers:

  • Added documentation for configurable retry mechanisms, including custom retry logic and the RetryConfiguration.default. ([README.mdR191-R233](https://github.com/strvcom/ios-networking/pull/75/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R191-R233))
  • Introduced modifiers like RequestAdapting, ResponseProcessing, ErrorProcessing, and RequestInterceptor for customizing network request pipelines. Provided examples of built-in classes implementing these protocols. ([README.mdR191-R233](https://github.com/strvcom/ios-networking/pull/75/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R191-R233))

Copy link
Collaborator

@cejanen cejanen left a comment

Choose a reason for hiding this comment

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

📜

@ipek
Copy link
Collaborator Author

ipek commented Jun 2, 2025

📜

Hehehe sorry, it's not ready yet. I created it prematurely and now I am investigating how the modulemap differs from current documentation and if everything checks out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants