Skip to content

Commit

Permalink
clarify installation of cli and library
Browse files Browse the repository at this point in the history
  • Loading branch information
JR-1991 committed Aug 13, 2024
1 parent a17a88b commit 0b9abc0
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,25 @@ Current capabilities include:

**Command line**

To install the command line tool, use `cargo:

```bash
cargo install --git https://github.com/JR-1991/rust-dataverse.git
```

**Cargo.toml**
After installation, you can interact with the Dataverse API using the dvcli command. Note that this command installs only the CLI tool, not the library itself. Instructions for adding the library to your project are provided below.

**Library**

Please note, this crate is not yet published on crates.io. You can add it to your `Cargo.toml` file by pointing to the
GitHub repository.
To include the library in your project, add this to your Cargo.toml file:

```toml
[dependencies]
dataverse = { git = "https://github.com/JR-1991/rust-dataverse" }
```

Since the library isn’t published on [crates.io](https://crates.io) yet, we’re using a git dependency. Once added, you can begin using the library in your project.

## Usage

### Command line
Expand Down

0 comments on commit 0b9abc0

Please sign in to comment.