docs: update README.md, and supplement CHANGELOG.md for pull #10

Author: WSH032

CHANGELOG.md

@@ -26,6 +26,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - [#10](https://github.com/WSH032/fastapi-proxy-lib/pull/10) - fix security vulnerabilities of cookies leakage between different users. Thanks [@WSH032](https://github.com/WSH032)!
 
+### Removed
+
+- [#10](https://github.com/WSH032/fastapi-proxy-lib/pull/10) - Remove support for setting cookies at the `AsyncClient` level. Thanks [@WSH032](https://github.com/WSH032)!
+
 ## [0.0.1b0] - 2023-11-27 [YANKED]
 
 !!! danger

CONTRIBUTING.md

@@ -172,9 +172,15 @@ hatch version {new_version}
 
 It will create a commit and tag automatically, then, push the **tag** to GitHub.
 
-After that, the `publish.yml` workflow will build and publish the package to PyPI.
+!!! warning
+    You should tag in another branch, then rebase it to `main` branch **in local**.<br>
+    **DO NOT rebase with tag in GitHub**, refer to <https://docs.github.com/zh/authentication/managing-commit-signature-verification/about-commit-signature-verification#signature-verification-for-rebase-and-merge>
+
+Check if everything is ok, for example, **check if the tag is on the `main` branch**.
 
-> Don't forget to make a `approve` in environment `pypi` for the workflow.
+If so, make a `approve` in environment `pypi` for the workflow.
+
+After that, the `publish.yml` workflow will build and publish the package to PyPI.
 
 Finally, edit the `draft release` created by `publish.yml` workflow, and publish the release.
 

README.md

@@ -31,6 +31,7 @@ Source Code: <https://github.com/WSH032/fastapi-proxy-lib/>
     - [x] Supports all HTTP methods (`GET`, `POST`, etc.)
 - [x] Support both **reverse** proxy and **forward** proxy.
 - [x] **Transparently** and **losslessly** handle all proxy requests,
+    Including **HTTP headers**, **cookies**, **query parameters**, **body**, etc.
 - [x] Asynchronous streaming transfer, support **file proxy**.
 
 ### other features
@@ -39,6 +40,8 @@ Source Code: <https://github.com/WSH032/fastapi-proxy-lib/>
 - [x] **100%** [Type Completeness](https://microsoft.github.io/pyright/#/typed-libraries?id=type-completeness), [Code coverage of **over 95%**][codecov#link].
 - [x] Forced keep-alive connections, minimizing proxy latency.
 - [x] Handle errors as gracefully as possible.
+    - `fastapi-proxy-lib` has a well-designed mechanism behind the scenes to handle exceptional websocket disconnections for you.
+    - `fastapi-proxy-lib` will exit as gracefully as possible.
 
 ### `FastAPI Proxy Lib` stands on the shoulders of giants
 
@@ -47,14 +50,17 @@ Source Code: <https://github.com/WSH032/fastapi-proxy-lib/>
 
 So, it perfectly supports all features of [httpx.AsyncClient](https://www.python-httpx.org/advanced/#client-instances), you can even use your custom `AsyncClient`, [`Transport`](https://www.python-httpx.org/advanced/#custom-transports).
 
+> except `cookies` and `base_url` arguments, which are taken over by `fastapi-proxy-lib`
+
 ## Installation
 
 > !!! note
 >
 >     We follow semantic versioning.<br>
 >     This is a young project, and before 1.0.0, there may be changes in the API (we try to avoid that).<br>
 >     We will release security updates at any time, please try to keep the version updated, instead of pinning to the old version.<br>
->     pin to `major version` is recommended.
+>     pin to `major version` is recommended.<br>
+>     visit our `CHANGELOG.md` for more info.
 
 ```shell
 pip install fastapi-proxy-lib