Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
benbalter committed Jul 7, 2014
1 parent 700b2e4 commit 259fa00
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 32 deletions.
23 changes: 0 additions & 23 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -88,18 +74,13 @@ 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)
swot (0.3.1)
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)
Expand All @@ -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
47 changes: 38 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
}
```

0 comments on commit 259fa00

Please sign in to comment.