From 259fa0086cfbba922c82daf6a8dded65fff3ae81 Mon Sep 17 00:00:00 2001
From: Ben Balter <ben.balter@github.com>
Date: Mon, 7 Jul 2014 09:57:22 -0400
Subject: [PATCH] update readme

---
 Gemfile.lock | 23 -----------------------
 README.md    | 47 ++++++++++++++++++++++++++++++++++++++---------
 2 files changed, 38 insertions(+), 32 deletions(-)

diff --git a/Gemfile.lock b/Gemfile.lock
index b561366..4a41dd4 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -22,16 +22,11 @@ GEM
     celluloid (0.15.2)
       timers (~> 1.1.0)
     coderay (1.1.0)
-    coffee-script (2.2.0)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.7.0)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     dnsruby (1.54)
     ethon (0.7.1)
       ffi (>= 1.3.0)
-    execjs (2.2.1)
     ffi (1.9.3)
     formatador (0.2.5)
     gman (2.1.3)
@@ -64,15 +59,6 @@ GEM
       method_source (~> 0.8.1)
       slop (~> 3.4)
     public_suffix (1.4.4)
-    rack (1.5.2)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-coffee (1.0.3)
-      coffee-script
-      rack
-    rack-protection (1.5.3)
-      rack
-    rack-ssl-enforcer (0.2.7)
     rake (10.3.2)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
@@ -88,10 +74,6 @@ GEM
     shoulda-context (1.2.1)
     shoulda-matchers (2.6.1)
       activesupport (>= 3.0.0)
-    sinatra (1.4.5)
-      rack (~> 1.4)
-      rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
     slop (3.5.0)
     sniffles (0.2.0)
       nokogiri (~> 1.6.1)
@@ -99,7 +81,6 @@ GEM
       public_suffix
     thor (0.19.1)
     thread_safe (0.3.4)
-    tilt (1.4.1)
     timers (1.1.0)
     typhoeus (0.6.9)
       ethon (>= 0.7.1)
@@ -117,14 +98,10 @@ DEPENDENCIES
   bundler
   guard-rake
   pry
-  rack-cache
-  rack-coffee
-  rack-ssl-enforcer
   rake
   rdoc
   rerun
   shoulda
-  sinatra
   site-inspector!
   vcr
   webmock
diff --git a/README.md b/README.md
index 92ace8c..0bff210 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,56 @@
 # Site Inspector (Ruby Edition)
 
+Information about a domain's technology and capabilities.
+
 A Ruby port and v2 of Site Inspector (http://github.com/benbalter/site-inspector)
 
 ## Demo
 
-[gov-inspector.herokuapp.com](https://gov-inspector.herokuapp.com)
+[gov-inspector.herokuapp.com](https://gov-inspector.herokuapp.com) ([source](https://github.com/benbalter/site-inspector-demo))
 
 ## Usage
 
 ```ruby
 site = SiteInspector.new "whitehouse.gov"
 site.https?
-# => false
+#  =>  false
 site.non_www?
-# => true
+#  =>  true
 site.cms
-# => { :drupal => {}}
+#  =>  { :drupal  =>  {}}
 ```
 
 ## Methods (what's checked)
 
-*comming soon*
-
-## Server
-
-There's a lightweight demo server included. Just run `script/server` and open `localhost:9292` in your browser.
+```ruby
+{
+  :domain                    => "cia.gov",
+  :uri                       => "https://www.cia.gov",
+  :government                => true,
+  :live                      => true,
+  :ssl                       => true,
+  :enforce_https             => true,
+  :non_www                   => true,
+  :redirect                  => nil,
+  :ip                        => "184.85.99.65",
+  :hostname                  => "a184-85-99-65.deploy.static.akamaitechnologies.com",
+  :ipv6                      => false,
+  :dnssec                    => false,
+  :cdn                       => "akamai",
+  :google_apps               => false,
+  :could_provider            => false,
+  :server                    => nil,
+  :cms                       => {},
+  :analytics                 => {},
+  :javascript                => { :jquery => {} },
+  :advertising               => {},
+  :slash_data                => false,
+  :slash_developer           => false,
+  :data_dot_json             => false,
+  :click_jacking_protection  => false,
+  :content_security_policy   => false,
+  :xss_protection            => false,
+  :secure_cookies            => nil,
+  :strict_transport_security => false
+}
+```