Skip to content

docs: Update readme with new installation method #44

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

Merged
merged 1 commit into from
Aug 16, 2022
Merged

docs: Update readme with new installation method #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ not create any local files.

## Installing

### Installing from crates.io

If you're a Rust programmer and have Rust installed locally, you can install dcp
by simply entering `cargo install dcp`, which will fetch the latest version from
crates.io.

### Download compiled binary

The [release section](https://github.com/exdx/dcp/releases) has a number
Expand All @@ -50,7 +56,7 @@ it easily.
## Implementation

Because there wasn't a suitable `containerd` client implementation in Rust at the time
of writing, `dcp` relies on APIs provided by an external crate. This limits `dcp` to working on systems where docker or podman is the container runtime.
of writing, `dcp` relies on APIs provided by external docker and podman crates. This limits `dcp` to working on systems where docker or podman is the container runtime.

By default, `dcp` will look for an active docker socket to connect to at the standard path. If the docker socket is unavailable, `dcp` will fallback to the current user's podman socket based on the $XDG_RUNTIME_DIR environment variable.

Expand Down