Permalink
Browse files

README to rdoc

  • Loading branch information...
Peter Schrammel
Peter Schrammel committed Jan 19, 2012
1 parent 2481085 commit 0f9dd41f047d46d2a863b7821d943f8fc512ea6d
Showing with 25 additions and 13 deletions.
  1. +1 −0 .gitignore
  2. +0 −13 README
  3. +24 −0 README.rdoc
  4. 0 Rakefile.rb → Rakefile
View
@@ -1,2 +1,3 @@
phantom_client-*.gem
.rvmrc
+doc/*
View
13 README
@@ -1,13 +0,0 @@
-Install:
-rake build
-rake install
-
-Uninstall:
-rake uninstall
-
-Usage example:
-
-require 'phantom_client'
-
-client = PhantomJSProxy::PhantomJSClient.new([{:addr => "127.0.0.1", :port => 5000}])
-dom = client.get("http://foo.de/", {:imageOnly => true, :withIframes => true})
View
@@ -0,0 +1,24 @@
+== Phantom Client
+Phantom Client is a clientlibrary to Phantom Proxy
+(see https://github.com/experteer/phantom_proxy).
+It's a thin layer around Net::HTTP to fetch a page
+through the Phantom Proxy with specific options.
+
+== Installation
+ rake build
+ rake install
+
+== Usage
+
+Usage example:
+
+ require 'phantom_client'
+
+ client = PhantomJSProxy::PhantomJSClient.new([{:addr => "127.0.0.1", :port => 5000}])
+ dom = client.get("http://foo.de/", {:imageOnly => true, :withIframes => true})
+
+== TODO
+* nicer API
+* gemify
+* namespace cleanup
+
View
File renamed without changes.

0 comments on commit 0f9dd41

Please sign in to comment.