Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rming committed Apr 28, 2024
1 parent 8a2e05e commit 6267815
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 38 deletions.
42 changes: 4 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,6 @@
# Dify SDK for Rust
# Dify SDK Workspace

## Description
This is the workspace for the Dify SDK. It contains the following packages:

This is the Rust SDK for Dify. It allows you to interact with the Dify API in a more convenient and type-safe way.

## Installation

To add `dify-client` to your package, add the following to your `Cargo.toml`:

```toml
[dependencies]
dify-client = "0.1.0"
```

## 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
```
- `dify-client`: The main package for the Dify SDK.
- `difysdk_test`: The test package for the Dify SDK.
38 changes: 38 additions & 0 deletions dify-client/README.md
Original file line number Diff line number Diff line change
@@ -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.0"
```

## 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
```

0 comments on commit 6267815

Please sign in to comment.