From 596aed17bd6d48eecca97ecc1818075e21b63bbf Mon Sep 17 00:00:00 2001 From: Thomas Eizinger Date: Tue, 10 Dec 2019 15:53:22 +0100 Subject: Replace invalid example in README with cargo example (#207) The example in the README is outdated and no longer compiles. To prevent this from happening again, this patch removes the example entirely and instead introduces a new example `custom_host` that will be checked during `cargo test`. Fixes #183. --- README.md | 20 -------------------- 1 file changed, 20 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 90899fe..41f9c1d 100644 --- a/README.md +++ b/README.md @@ -15,26 +15,6 @@ shiplift = "0.6" ## usage -### communicating with hosts - -To use shiplift, you must first have a docker daemon readily accessible. Typically this daemon process -is resolvable via a url specified by an env var named `DOCKER_HOST`. - -```rust -let docker = shiplift::Docker::new(); -``` - -If you wish to be more explicit you can provide a host in the form of a `url.Url`. - -```rust -use shiplift::Docker; -use url::Url; - -let docker = Docker::host(Url::parse("http://yourhost").unwrap()); -``` - -### Examples - Many small runnable example programs can be found in this repository's [examples directory](https://github.com/softprops/shiplift/tree/master/examples). ## planned changes -- cgit v1.2.3