diff options
author | Thomas Eizinger <thomas@eizinger.io> | 2019-12-10 15:53:22 +0100 |
---|---|---|
committer | Doug Tangren <d.tangren@gmail.com> | 2019-12-10 09:53:22 -0500 |
commit | 596aed17bd6d48eecca97ecc1818075e21b63bbf (patch) | |
tree | 02c8283e3e6b597c500f0cff60ae81f417bf24fd /README.md | |
parent | eb1ad605157b14fc9e1329b617aea8012abde1c9 (diff) |
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.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 20 |
1 files changed, 0 insertions, 20 deletions
@@ -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 |