Skip to content

Commit

Permalink
docs: update dependencies
Browse files Browse the repository at this point in the history
Signed-off-by: Homing So <[email protected]>
  • Loading branch information
hominsu committed Dec 17, 2024
1 parent 87a16c8 commit c26c68b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,22 @@

## Usage

Clone the repository:
### Docker Deployment

```shell
git clone https://github.com/hominsu/deeplx-rs.git
```
1. Clone the repository:
```shell
git clone https://github.com/hominsu/deeplx-rs.git
```
2. Start the container:
```shell
cd deploy
docker-compose up -d
```

Start the container:
### Install with Cargo

```shell
cd deploy
docker-compose up -d
cargo install --features=impersonate,server
```

## Integration
Expand All @@ -58,21 +63,21 @@ Add `deeplx` to your `Cargo.toml`:

```toml
[dependencies]
deeplx = "0.1"
deeplx = "1"
```

By default, deeplx includes proxy support. If you do not need proxy support, disable the default features:

```toml
[dependencies]
deeplx = { version = "0.1", default-features = false }
deeplx = { version = "1", default-features = false }
```
If you want to enable the impersonate feature to mimic browser headers, TLS settings, etc.:
```toml
[dependencies]
deeplx = { version = "0.1", features = ["impersonate"] }
deeplx = { version = "1", features = ["impersonate"] }
```
### Configuration
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
//!
//! ```toml
//! [dependencies]
//! deeplx = { version = "0.1", default-features = false }
//! deeplx = { version = "1", default-features = false }
//! ```
//!
//! When the `proxy` feature is enabled (default), you can specify a proxy when creating a new [`DeepLX`] instance:
Expand All @@ -27,7 +27,7 @@
//!
//! ```toml
//! [dependencies]
//! deeplx = { version = "0.1", features = ["impersonate"] }
//! deeplx = { version = "1", features = ["impersonate"] }
//! ```
//!
//! The core structure of this library is [`DeepLX`], through which you can:
Expand Down

0 comments on commit c26c68b

Please sign in to comment.