-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
Clarify installation of CLI and library in README
#8
base: master
Are you sure you want to change the base?
Clarify installation of CLI and library in README
#8
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi
Some minor modifications:
- Backticks around dvcli to get
dvcli
as is the convention usually followed in Markdown - Reference to example section
- Reminder library install is not related to or for cli use. Maybe we should be more explicit and say something in the lines of 'for users of
dvcli
command line' and later 'for developers'
Please check as I might have made some typos in the diff
Best
diff.txt
Here a copy of the diff in case the file didnt work
diff --git a/Readme.md b/Readme.md
index 9a1402d..e00d06d 100644
--- a/Readme.md
+++ b/Readme.md
@@ -49,7 +49,7 @@ To install the command line tool, use `cargo:
cargo install --git https://github.com/JR-1991/rust-dataverse.git
-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.
+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.
@samusz, thanks for the feedback! I’ve committed your changes to the PR. I agree that distinguishing between the developer and user perspectives is both important and necessary. I’ve put together a proposal that addresses the needs of both groups. I’d love to hear your thoughts on it. Command line tool The To install cargo install --git https://github.com/JR-1991/rust-dataverse.git After installation, you can interact with the Dataverse API using the Library If you are a developer looking to integrate Dataverse into your Rust application, you can use this crate as a library. To include it in your project, add the following to your [dependencies]
dataverse = { git = "https://github.com/JR-1991/rust-dataverse" } Since the library isn’t published on crates.io yet, we’re using a git dependency. Once added, you can begin using the library in your project. |
This looks great! It is very informative and to the point. |
As noted in issue #6, the existing
README
does not clearly differentiate between the installation steps for the CLI and the library. This PR updates theREADME
to provide clearer instructions on which commands to use for each scenario.Closes #6