Permalink
Browse files

docs

  • Loading branch information...
samliu committed Jun 19, 2012
1 parent 506b73c commit 342f2fd0cb77a17c677815711d26f047e3db521b
Showing with 25 additions and 0 deletions.
  1. +2 −0 docs/architecture.rst
  2. +4 −0 docs/howto.rst
  3. +15 −0 docs/index.rst
  4. +4 −0 docs/installation.rst
View
@@ -0,0 +1,2 @@
+Architecture
+============
View
@@ -0,0 +1,4 @@
+Howto
+=====
+
+This document contains information on how to use Spade.
View
@@ -6,11 +6,26 @@
Welcome to Spade's documentation!
=================================
+**Overview:** Spade is at its core a metrics tool that allows quick visualization of
+what kinds of CSS properties websites are using. It allows input of
+a list of websites to scrape, and it crawls to 1 level on each website
+whilst submitting a variety of user agent strings in order to ascertain
+different kinds of markup returned as a result. It tries to detect UA
+sniffing by commparing the returned markup structure of each site.
+
+All the information is recorded into a database after the crawl, and
+is accessible from a web interface. For more information on installation
+and use of the tool, please continue through the documentation.
+
Contents:
.. toctree::
:maxdepth: 2
+ installation
+ howto
+ architecture
+
Indices and tables
View
@@ -0,0 +1,4 @@
+Installation
+============
+
+To install, blah blah blah

0 comments on commit 342f2fd

Please sign in to comment.