Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Khalid Lafi authored and Khalid Lafi committed Oct 13, 2013
1 parent eb33f76 commit 456f981
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 7 deletions.
39 changes: 33 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,28 @@
Spof
====

See what will happen when third-party resource goes down!
for more info read [this article](www.stevesouders.com/blog/2010/06/01/frontend-spof/)
See what will happen to your site when a third-party provider goes down!

It uses a [Blackhole server](http://en.wikipedia.org/wiki/Blackhole_server) by [Web page test](http://www.webpagetest.org/) to simulate what will happen if a third-party provider goes down.

sudo npm install spof -g
For more info read [this article](www.stevesouders.com/blog/2010/06/01/frontend-spof/) By [Steve Souders](http://www.stevesouders.com/)


Usage

_______
Installation
----------
First you need to install [Phantomjs](http://phantomjs.org).
First you need to install [Nodejs](http://nodejs.org) and [Phantomjs](http://phantomjs.org).

Then in your command line run:

sudo npm install spof -g

_______

Usage
--------

spof --website http://github.com --css --js --port 3001

- **--js**: SPOF javascripts
Expand All @@ -25,12 +34,30 @@ Then in your command line run:
![usage](http://f.cl.ly/items/2R332X2a2l46030m3b0o/spof.mov.gif)


_______

Author
--------
[Khalid Lafi](http://github.com/lafikl)
[@lafikl](http://twitter.com/lafikl)
[(@LafiKL)](http://twitter.com/lafikl)



__________

Roadmap
----------
- Spof a certain file or a resource e.g ( example.com, example.com/app.js )


_______


Shout out
----------
- Thanks to [Steve Souders](http://www.stevesouders.com/) for his researches.
- Thanks to [Patrick Meenan](http://blog.patrickmeenan.com/) on his work at Web Page test and their blackhole server which i use in this tool!

License
---------
The MIT License (MIT)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "spof",
"version": "0.0.6",
"version": "0.0.7",
"description": "See what will happen when third-party resource goes down!",
"main": "./lib/main",
"scripts": {
Expand Down

0 comments on commit 456f981

Please sign in to comment.