Skip to content

chore: update README. #3

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 12, 2025
Merged

chore: update README. #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,26 @@

## Getting started

TODO: complete this document
TODO: complete this section

## How this crate differs from [`http-stream`][http-stream]
## How this crate differs from [`http-cache`][http-cache]

The [`http-cache`][http-cache] crate is a highly-configurable HTTP cache that
supports different storage backends and middleware for many popular Rust HTTP
client APIs.

The `http-cache-stream` crate is inspired by the implementation provided by
`http-cache`, but differs in significant ways:

* `http-cache-stream` supports streaming of requests/responses and does not
read a response body into memory to store in the cache.
* The default storage implementation for `http-cache-stream` uses advisory file
locking to coordinate access to storage across multiple processes and threads.
* The default storage implementation is simple and provides no integrity of
cached bodies, but does provide some fault tolerance for writes to cache
storage (i.e. partially written cache entries are discarded).
* The API for `http-cache-stream` is not nearly as configurable as `http-cache`.
* Only a middleware implementation for `reqwest` will be made initially.

## Development

Expand Down Expand Up @@ -60,10 +77,10 @@ following checks (from the root directory).

```bash
# Run the project's tests with tokio as the async runtime.
cargo test --no-default-features --features tokio
cargo test

# Run the project's tests with async-std as the async runtime.
cargo test --no-default-features --features async-std
# Run the reqwest middleware tests
cargo test -p http-cache-stream-reqwest

# Ensure the project doesn't have any linting warnings.
cargo clippy --all
Expand All @@ -89,4 +106,4 @@ This project is licensed under the [Apache 2.0][license] license.
Copyright © 2025-Present [Peter Huene](https://github.com/peterhuene).

[license]: https://github.com/peterhuene/http-cache-stream/blob/main/LICENSE
[http-stream]: https://github.com/06chaynes/http-cache
[http-cache]: https://github.com/06chaynes/http-cache