From b903225a9ac89dc0862faf7768d46adcbee5ecb8 Mon Sep 17 00:00:00 2001
From: kingzcheung <kingzcheung@gmail.com>
Date: Tue, 6 Jun 2023 17:21:40 +0800
Subject: [PATCH] update readme.md

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2d3cbaf..8399555 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,36 @@
 # Huaweicloud OBS SDK (unofficial)
 
-> WIP. 计划只支持基本的 obs 操作。
\ No newline at end of file
+> WIP. 计划只支持基本的 obs 操作。
+
+## 基本使用
+
+1. 添加 sdk 到项目中:
+
+```
+cargo add huaweicloud-sdk-rust-obs
+```
+
+2.示例
+
+```rust
+#[tokio::main]
+async fn main() -> Result<(), ObsError> {
+    const DEFAULT_BUCKET_NAME:&str = "test_bucket";
+    let endpoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
+    // see: https://support.huaweicloud.com/api-obs/obs_04_0116.html
+    let ak = "xxx"; 
+    let sk = "xxxxxx";
+    let obs = client::Client::builder()
+        .endpoint(endpoint)
+        .security_provider(ak, sk)
+        .build()?;
+
+    // put object
+    let object = include_bytes!("testdata/test.jpeg");
+    obs.put_object(DEFAULT_BUCKET_NAME, "obs-client-key.jpeg", object)
+        .await?;
+
+    Ok(())
+
+}
+```