diff options
author | softprops <d.tangren@gmail.com> | 2015-05-06 00:31:19 -0400 |
---|---|---|
committer | softprops <d.tangren@gmail.com> | 2015-05-06 00:31:19 -0400 |
commit | 1487c89b294f24b2fc4e19ce1e68bd16c9593178 (patch) | |
tree | 1dd46c302a3a9e7228f22c823e781e1139a508c3 /README.md | |
parent | 314715d99112385d2d7e850beb542e60a1d2d8f3 (diff) |
start jotting down readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
@@ -8,5 +8,43 @@ Find them [here](https://softprops.github.io/shiplift) +## usage + +### communicating with host + +To use shiplift you must first have a running docker daemon readily accessible. Typically this daemon +is reachable via url identified by an env named `DOCKER_HOST`. If you are using osx, boot2docker typically +will have already set up every thing you need to get started. + +```rust +extern crate shiplift; +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 +extern crate shiplift; +extern crate url; + +use shiplift::Docker; +use url::Url; + +let docker = Docker::host(Url::parse("http://yourhost").unwrap()); +``` + +### images + +If you are interacting with docker containers, chances are you will also need to interact with docker image information. + +todoc + +### containers + +todoc + +### misc + +todoc Doug Tangren (softprops) 2015 |