Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify installation of CLI and library in README #8

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Clarify installation of CLI and library in README #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b9abc0
clarify installation of cli and library
JR-1991 Aug 13, 2024
b28c218
apply proposed changes of @samusz
JR-1991 Aug 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions Readme.md
View file
Open in desktop
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. See usage examples bellow. Note that this command installs only the CLI tool, not the library itself. Instructions for adding the library to your project are provided below. You don't need to install the library in order to use the `dvcli` command line.

**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