summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsoftprops <d.tangren@gmail.com>2016-01-03 22:34:00 -0500
committersoftprops <d.tangren@gmail.com>2016-01-03 22:34:00 -0500
commitdf58427f607322f9af994edf6de22997e5fb27d4 (patch)
tree0abfeed7cfc747fb86ee6dcde760f520a4523cbc /README.md
parent22009e669f0584238f8c8f51089882bda367e0f8 (diff)
install notes
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index ab4cf29..3fedd11 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,25 @@
[![Build Status](https://travis-ci.org/softprops/shiplift.svg)](https://travis-ci.org/softprops/shiplift)
-> a rust interface for maneuvering docker containers
+> a rust interface for maneuvering [docker](https://www.docker.com/) containers
+
+## install
+
+Add the following to your `Cargo.toml` file
+
+```toml
+[dependencies]
+shiplift = "0.2"
+```
## docs
-Find them [here](https://softprops.github.io/shiplift)
+Find them [here](https://softprops.github.io/shiplift).
## usage
+Some small example programs can be found [here](https://github.com/softprops/shiplift/tree/master/examples).
+
### communicating with hosts
To use shiplift you must first have a running docker daemon readily accessible. Typically this daemon