mirror
/
sitespeed.io
mirror of https://github.com/sitespeedio/sitespeed.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Moving to sitespeed.io [skip ci]

This commit is contained in:
Peter Hedenskog 2012-12-05 21:20:29 +01:00
parent b1d74f6c21
commit 540c56188f
1 changed files with 1 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -3,43 +3,4 @@
Sitespeed.io is an open source tool that helps you analyze and optimize your website speed and performance, based on performance best practices rules.
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 & analyzed.
The flow looks something like this:
<img src="http://sitespeed.io/img/sitespeed.io-1.2-workflow.png">
More information: <a href="http://sitespeed.io">http://sitespeed.io</a>
Install
-------
<ol>
<li>Install PhantomJs http://phantomjs.org/download.html</li>
<li>Install Java 1.7</li>
<li>Checkout this repository <code>git clone git@github.com:soulgalore/sitespeed.io.git</code></li>
</ol>
How to run
-------
Run the script with a parameter that is the start page of where you want to test
<code>
./sitespeed.io -u http://github.com/
</code>
If you want to crawl deeper than one level, that is the next parameter.
<code>
./sitespeed.io -u http://github.com/ -d 2
</code>
Roadmap
-------
See the issue list.
Mad props
-------
* Marcel Duran for Yslow https://github.com/marcelduran/yslow/ without it sitespeed would be nothing :)
* Ariya Hidayat for PhantomJS https://github.com/ariya/phantomjs
* Mark Otto & Jacob Thornton for Twitter Bootstrap https://github.com/twitter/bootstrap/
See <a href="http://sitespeed.io">http://sitespeed.io</a> for documentation.