docs

.travis.yml

@@ -1,25 +1,20 @@
 sudo: false
-
 language: rust
-
 matrix:
   fast_finish: true
   include:
   - rust: nightly
   - rust: beta
   - rust: stable
-
 script:
 - cargo build
 - cargo test
-
 cache:
   cargo: true
   apt: true
   directories:
   - target/debug/deps
   - target/debug/build
-
 addons:
   apt:
     packages:
@@ -29,7 +24,6 @@ addons:
     - cmake
     - gcc
     - binutils-dev
-
 after_success: |
   [ $TRAVIS_RUST_VERSION = stable ] &&
   [ $TRAVIS_BRANCH = master ] &&
@@ -48,3 +42,6 @@ after_success: |
   make install DESTDIR=../tmp &&
   cd ../.. &&
   ./kcov-master/tmp/usr/local/bin/kcov --verify --coveralls-id=$TRAVIS_JOB_ID --exclude-pattern=/.cargo target/kcov target/debug/scuttlebutt-*
+env:
+  global:
+    secure: DzjCwZae6k/GyYLJ5x3wgDIjO8SjzkAq3eI8RvRT4aqSfVai2x3y4bPk5QoX+lt6TLaJxmoc1Vq6HZJbNlKokpGAvyzwJ0qmCBWYCUcRyTUyAVmH8VEY/wnBF0k8lYiQmfxOeGhiQb8nHZSpIIhItfIUirKMXyCW3ArkVV5HzQa53T1mO3unY9AEnDgyHfmwke0QM6MYdHAhNjfg45dvckU6Euu2oAXZ0tQpf0+uDPpU78Mg3dJ523/REuhKgRjreHt3S99R8rmnlKY9ZQeK0Zg4ZE4e+xxeC0H67CIhLWZiIwqZxauA7zB11UXI7GZ6fZoPsvZN3U3TlJwaAU/RHzGBczZVxGqgujwsbrne2WRYFtnFirs8D15uRp4ix4UIyKaUeqy5rUoZcLAzKIWDNLTJ5bQvyhDN641eF1auPURr0z7g+tQc8uEEKmuJXR+PplHPzvGOTz54dQa603XeEoERjL/59XqcbJFCoW3FqIxlLMosBOyQBfE1eGpkisFUdZ6YYODEFFOggF1JWF5psP9DUJ9CX852EdPpgIzojvmo9KqeeBiHw/I02rTRa6QgsIT0uea5HlV6eNo0le9AeT3fMYfVU/wzDJxH/2mt42SCvLSbbXl9Nam1KUtEvjc5cGhD4vjnX6G2hAiY/xPXuvmlZ8btwlaykeI//wdvq7o=

src/lib.rs

@@ -11,6 +11,7 @@ include!(concat!(env!("OUT_DIR"), "/lib.rs"));
 
 pub type Result<T> = std::result::Result<T, Error>;
 
+/// An enumerator of potential errors
 #[derive(Debug)]
 pub enum Error {
     Transport(HttpError),
@@ -22,10 +23,15 @@ impl From<HttpError> for Error {
     }
 }
 
+/// A cluster contains an address
+/// for interacting with a kubernetes Cluster
+/// of nodes
 pub struct Cluster {
     host: Url,
 }
 
+/// Events provides a means for generating
+/// a reciever for events
 pub trait Events {
     fn events(&mut self) -> Result<Receiver<Event>>;