This is an automated email from the ASF dual-hosted git repository.
liuhongyu pushed a commit to branch bugfix/fix_publish_error
in repository https://gitbox.apache.org/repos/asf/shenyu-client-rust.git
The following commit(s) were added to refs/heads/bugfix/fix_publish_error by
this push:
new a8c826c [type:bugfix] fix publish error
a8c826c is described below
commit a8c826cf25c0d5ab65332be654e9fc26e14ec99a
Author: liuhy <[email protected]>
AuthorDate: Tue Jan 21 10:03:41 2025 +0800
[type:bugfix] fix publish error
---
shenyu-client-rust/README.md | 31 +++++++++++++++++++++++++++++++
1 file changed, 31 insertions(+)
diff --git a/shenyu-client-rust/README.md b/shenyu-client-rust/README.md
new file mode 100644
index 0000000..4cdaf1c
--- /dev/null
+++ b/shenyu-client-rust/README.md
@@ -0,0 +1,31 @@
+# Apache ShenYu-Client-Rust
+
+The Apache `ShenYu` Rust Client SDK is a Rust library for interacting with the
Apache `ShenYu` gateway. This SDK allows you to easily integrate your Rust
applications with the `ShenYu` gateway, providing a seamless way to manage and
route your API requests.
+
+## Installation
+
+To use the Apache `ShenYu` Rust Client SDK in your project, add the following
dependencies to your `Cargo.toml` file:
+
+```toml
+[dependencies]
+serde = "1.0.190"
+serde_json = "1.0.80"
+reqwest = "0.12.5"
+axum = "0.5"
+tokio = "1.39.3"
+shenyu-client-rust = {version = "0.1.1", features = ["actix-web", "axum"] }
+```
+
+## Usage
+
+Below is an example of how to create an Axum service using `ShenYuRouter` and
integrate it with the `ShenYu` Gateway.
+
+### Example
+
+See
[examples](https://github.com/apache/shenyu-client-rust/tree/main/examples).
+
+This example demonstrates how to set up a basic Axum service using
`ShenYuRouter` and register it with the `ShenYu` Gateway. `health_handler` and
`create_user_handler` are simple asynchronous functions that handle HTTP
requests.
+
+## License
+
+This project is licensed under the Apache License 2.0. For more details, see
the [LICENSE](LICENSE) file.
