From a0f225d00af8f610a5414602dbe6d1ff7ffe8f1e Mon Sep 17 00:00:00 2001 From: Peter Hedenskog Date: Mon, 13 Aug 2012 22:23:36 +0200 Subject: [PATCH] more content [skip ci] --- README.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4759fac60..3390aa5e3 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,38 @@ Sitespeed.io - how speedy is your site? [![Build Status](https://secure.travis-c Under construction :) -How to use +Sitespeed.io is a tool that analyzes web sites and give you information of why they are slow or at least, how they could be faster. Today yslow rules are used in combination with other best practices. + +What do sitespeed.io do? +------- +You give sitespeed a start point, the first page on your site, where you want it to start crawl. By default, one level will be crawled, meaning all links (on the same domain as the main page), will be fetched & later analyzed. + +The output is by default HTML. One summary page, that on high level will give you input about your speed of your site. You can also see all the individual pages and their assets. + +Prerequisites -------
  1. Install PhantomJs http://code.google.com/p/phantomjs/wiki/Installation
  2. Install Java 1.7
  3. Checkout this repository
  4. -
  5. Run the script with the url you want to test: - -./sitespeed.io http://peterhedenskog.com - -
-More info: http://sitespeed.io +How to run +------- +Run the script with a parameter that is the start page of where you want to test + +./sitespeed.io http://github.com/ + + +If you want to crawl deeper than one level, that is the next parameter. + +./sitespeed.io http://github.com/ 2 + + +If your site is behind basic auth, you can fetch it by + +./sitespeed.io http://github.com/hidden/ 1 login password + Mad props -------