From 0b8f10f75907def41543bbe89992f8d347f8ecb3 Mon Sep 17 00:00:00 2001 From: Jared Ramon Elizan Date: Mon, 21 Nov 2022 01:41:38 +0800 Subject: [PATCH] README.md (#129) fixed typos --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f575b9f5..e281ae34 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ miniz_oxide 0.5.x and 0.6.x Requires at least rust 1.40.0, 0.3.x requires at lea For a friendlier streaming API using readers and writers, [flate2](https://crates.io/crates/flate2) can be used, which can use miniz_oxide as a rust-only back-end. ## miniz_oxide_C_API -The C API is intended to replicate the api exported from miniz, and in turn also part of zlib. The C header is generated using [cbindgen](https://github.com/eqrion/cbindgen). The current implementation has not seen a lot of testing outside of automated test, is a bit weak in documentation and should be seen as experimental. +The C API is intended to replicate the API exported from miniz, and in turn also part of zlib. The C header is generated using [cbindgen](https://github.com/eqrion/cbindgen). The current implementation has not seen a lot of testing outside of automated tests, is a bit weak in documentation and should be seen as experimental. The data structures do not share the exact same layout that is specified in miniz.h (from the original miniz), and should thus be allocated via the included functions. @@ -39,7 +39,7 @@ $ ./travis-after-success.sh ### Including in C/C++ projects -Link against the `libminiz_oxide_c_api.a` generated by `build.sh`. The generated header that can be used `miniz.h` (using the original miniz headers may or may not work), which currently also uses `miniz_extra_defs.h` for some static definitions. +Link against the `libminiz_oxide_c_api.a` generated by `build.sh`. The generated header that can be used is `miniz.h` (using the original miniz headers may or may not work), which currently also uses `miniz_extra_defs.h` for some static definitions. ### Cargo-fuzz testing