From 5138a520e7935455af130d9578e4f294d7986454 Mon Sep 17 00:00:00 2001 From: afa Date: Sun, 28 Apr 2024 16:09:58 +0800 Subject: [PATCH] update readme --- README.md | 8 +++----- dify-client/Cargo.toml | 2 +- dify-client/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+), 6 deletions(-) create mode 100644 dify-client/README.md diff --git a/README.md b/README.md index 09677d8..e4947cc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -# Dify SDK for Rust +# Dify Client -## Description - -This is the Rust SDK for Dify. It allows you to interact with the Dify API in a more convenient and type-safe way. +The Dify Client is a Rust library for interacting with the Dify service. It provides a convenient way to integrate Dify functionality into your Rust applications. ## Installation @@ -10,7 +8,7 @@ To add `dify-client` to your package, add the following to your `Cargo.toml`: ```toml [dependencies] -dify-client = "0.1.0" +dify-client = "0.1" ``` ## Test diff --git a/dify-client/Cargo.toml b/dify-client/Cargo.toml index 36346bd..53c57f0 100644 --- a/dify-client/Cargo.toml +++ b/dify-client/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "dify-client" -version = "0.1.0" +version = "0.1.1" edition = "2021" description = "A client for the Dify API" license = "Apache-2.0" diff --git a/dify-client/README.md b/dify-client/README.md new file mode 100644 index 0000000..e4947cc --- /dev/null +++ b/dify-client/README.md @@ -0,0 +1,38 @@ +# Dify Client + +The Dify Client is a Rust library for interacting with the Dify service. It provides a convenient way to integrate Dify functionality into your Rust applications. + +## Installation + +To add `dify-client` to your package, add the following to your `Cargo.toml`: + +```toml +[dependencies] +dify-client = "0.1" +``` + +## Test + +To run the tests, you need to set the `DIFY_API_KEY` and `DIFY_BASE_URL` environment variables. + +```bash +export DIFY_API_KEY=your_api_key +export DIFY_BASE_URL=https://api.dify.io +``` + +Then you can run the tests with: + +```sh +cargo test +# cargo test -- --nocapture +# cargo test test_feedback_message -- --nocapture +``` + +## Docs + +To generate the documentation, run: + +```sh +# cargo clean --doc +cargo doc --no-deps --lib --document-private-items --open +```