Update Readme Files

Now includes warning about the need for samples to be deployed to a publicly accessible web server.
valitnon · Nov 1, 2015 · de9c509 · de9c509
1 parent 8004756
commit de9c509
Show file tree

Hide file tree

Showing 10 changed files with 102 additions and 27 deletions.
diff --git a/aspnet/readme.txt b/aspnet/readme.txt
@@ -12,7 +12,13 @@ Open the GrabzIt solution file.
 Screenshots in Web Applications
 ===============================
 
-The solution contains a project called Sample, which is a example web application. To configure this do the following:
+The solution contains a project called Sample, which is a example web application.
+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ As this example uses a callback handler it must be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+To configure this do the following:
 
 Then open web.config and change the application key and application secret to match your settings the first two parameters can be got from http://grabz.it/api
 

diff --git a/java/readme.txt b/java/readme.txt
@@ -5,9 +5,13 @@ This library allows you to programmatically convert web pages into images, PDF's
 
 Its usually best to place these package files in their own directory.
 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ As this example uses a callback handler it must be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
 To run the sample
 
-Open config.properties and change the three parameters to match your settings the first two parameters can be got from http://grabz.it/api
+Open config.properties and change the three parameters to match your settings the first two parameters can be got from http://grabz.it/api/
 the third parameter is the location of the handler (Handler.java in the sample application) on your website.
 
 
@@ -19,4 +23,4 @@ Ensure your application has read and write access to the "results" directory.
 
 Finally run the sample web application to start converting web pages into screenshots.
 
-More documentation can be found at: http://grabz.it/api/java
+More documentation can be found at: http://grabz.it/api/java/
diff --git a/nodejs/grabzitdemo/readme.txt b/nodejs/grabzitdemo/readme.txt
@@ -0,0 +1,22 @@
+GrabzIt 2.2
+===========
+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ As this example uses a callback handler it must be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+To run the sample
+
+Open config.js and change the three parameters to match your settings the first two parameters can be got from http://grabz.it/api/
+the third parameter is the location of the handler on your website.
+
+
+config.applicationKey=APPLICATION KEY
+config.applicationSecret=APPLICATION SECRET
+config.callbackHandlerUrl=http://www.example.com/grabzit/handler
+
+Ensure your application has read and write access to the "/public/results" directory.
+
+Finally run the sample web application to start converting web pages into screenshots.
+
+More documentation can be found at: http://grabz.it/api/nodejs/
diff --git a/perl/readme.txt b/perl/readme.txt
@@ -5,9 +5,13 @@ This library allows you to programmatically convert web pages into images, PDF's
 
 Its usually best to place these files in thier own directory.
 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ As this example uses a callback handler it must be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
 To run the sample
 
-Open config.ini and change the three parameters to match your settings the first two parameters can be got from http://grabz.it/api
+Open config.ini and change the three parameters to match your settings the first two parameters can be got from http://grabz.it/api/
 the third parameter is the location you have placed the handler.pl on your website.
 
 
@@ -20,4 +24,4 @@ Ensure your application has read and write access to the "results" directory.
 
 Finally run the index.pl to start taking screenshots.
 
-More documentation can be found at: http://grabz.it/api/perl
+More documentation can be found at: http://grabz.it/api/perl/
diff --git a/php/readme.txt b/php/readme.txt
@@ -5,9 +5,13 @@ This library allows you to programmatically convert web pages into images, PDF's
 
 Its usually best to place these package files in their own directory.
 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ As this example uses a callback handler it must be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
 To run the sample
 
-Open config.php and change the three parameters to match your settings the first two parameters can be got from http://grabz.it/api
+Open config.php and change the three parameters to match your settings the first two parameters can be got from http://grabz.it/api/
 the third parameter is the location you have placed the GrabzItHandler.php on your website.
 
 
@@ -19,4 +23,4 @@ Ensure your application has read and write access to the "results" directory.
 
 Finally run the index.php to start converting web pages.
 
-More documentation can be found at: http://grabz.it/api/php
+More documentation can be found at: http://grabz.it/api/php/
diff --git a/python/readme.txt b/python/readme.txt
@@ -1,20 +1,20 @@
 GrabzIt 2.2
-===========
+===========
+This library allows you to programmatically convert web pages into images, PDF's, CSV's and spreadsheets. Additionally GrabzIt allows you to convert online videos into animated GIF's.
 
-This library allows you to programmatically convert web pages into images, PDF's, CSV's and spreadsheets. Additionally GrabzIt allows you to convert online videos into animated GIF's.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ As this example uses a callback handler it must be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 To run the sample
 
-Open config.ini and change the three parameters to match your settings the first two parameters can be got from http://grabz.it/api
+Open config.ini and change the three parameters to match your settings the first two parameters can be got from http://grabz.it/api/
 
 The third parameter is the location you have placed the handler.py on your website.
-
-applicationKey=APPLICATION KEY
-applicationSecret=APPLICATION SECRET
-handlerUrl=http://www.example.com/grabzit/handler.py
+applicationKey=APPLICATION KEY
+applicationSecret=APPLICATION SECRET
+handlerUrl=http://www.example.com/grabzit/handler.py
 
 Ensure your application has read and write access to the "results" directory.
-
-Finally run the index.py to start taking screenshots.
-
-More documentation can be found at: http://grabz.it/api/python
+Finally run the index.py to start taking screenshots.
+More documentation can be found at: http://grabz.it/api/python/

diff --git a/ruby/readme.txt b/ruby/readme.txt
@@ -5,16 +5,20 @@ This library allows you to programmatically convert web pages into images, PDF's
 
 Its usually best to place these files in thier own directory.
 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ As this example uses a callback handler it must be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
 To run the sample
 
 First of all navigate to GrabzItDemo and in the command line run "bundle install"
 
-Open GrabzItDemo\config\config.yml then change YOUR APPLICATION KEY and YOUR APPLICATION SECRET to match the your application key and secret that can be retrieved from http://grabz.it/api
+Open GrabzItDemo\config\config.yml then change YOUR APPLICATION KEY and YOUR APPLICATION SECRET to match the your application key and secret that can be retrieved from http://grabz.it/api/
 
-Change the third parameter "URL OF YOUR GrabzIt Handler FILE (http://www.example.com/handler/index)" to match the location you have placed the handler/index at on your website so :http://www.example.com/handler/index
+Change the third parameter "URL OF YOUR GrabzIt Handler FILE (http://www.example.com/handler/index)" to match the location you have placed the handler/index at on your website so: http://www.example.com/handler/index
 
 Ensure your application has read and write access to the "GrabzItDemo\public\screenshots" directory.
 
 Finally run the GrabzItDemo to start taking screenshots.
 
-More documentation can be found at: http://grabz.it/api/ruby
+More documentation can be found at: http://grabz.it/api/ruby/
diff --git a/scraper/aspnet/readme.txt b/scraper/aspnet/readme.txt
@@ -0,0 +1,21 @@
+GrabzIt Scraper 1.0
+===================
+
+This library enables you to process scraped data and integrate it into your own application.
+
+Its usually best to place these package files in their own directory.
+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ For your application to be reachable by GrabzIt it must first be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Running the Demo Application
+----------------------------
+
+First create a scrape here: http://grabz.it/scraper/scrapes.aspx On the Export Options tab choose "Callback URL" option from the Send Results Via drop down.
+
+Next enter the URL of the handler so for instance http://www.example.com/scrape/handler
+
+Ensure your ASP.NET application has read and write access to the "results" directory.
+
+More documentation can be found at: http://grabz.it/scraper/api/aspnet/
diff --git a/scraper/php/readme.txt b/scraper/php/readme.txt
@@ -5,11 +5,16 @@ This library enables you to process scraped data and integrate it into your own
 
 Its usually best to place these package files in their own directory.
 
-To run this example create a scrape here: http://grabz.it/scraper/scrapes.aspx
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ For your application to be reachable by GrabzIt it must first be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-On the Export Options tab choose "Callback URL" option from the Send Results Via drop down.
+Running the Demo Application
+----------------------------
 
-Then enter the URL of the handler.php so for instance http://www.example.com/scrape/handler.php
+First create a scrape here: http://grabz.it/scraper/scrapes.aspx On the Export Options tab choose "Callback URL" option from the Send Results Via drop down.
+
+Next enter the URL of the handler.php so for instance http://www.example.com/scrape/handler.php
 
 Ensure your PHP application has read and write access to the "results" directory.
 

diff --git a/scraper/python/readme.txt b/scraper/python/readme.txt
@@ -5,11 +5,16 @@ This library enables you to process scraped data and integrate it into your own
 
 Its usually best to place these package files in their own directory.
 
-To run this example create a scrape here: http://grabz.it/scraper/scrapes.aspx
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ For your application to be reachable by GrabzIt it must first be deployed to a publicly accessible web server.+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-On the Export Options tab choose "Callback URL" option from the Send Results Via drop down.
+Running the Demo Application
+----------------------------
 
-Then enter the URL of the handler.py so for instance http://www.example.com/scrape/handler.py
+First create a scrape here: http://grabz.it/scraper/scrapes.aspx On the Export Options tab choose "Callback URL" option from the Send Results Via drop down.
+
+Next enter the URL of the handler.py so for instance http://www.example.com/scrape/handler.py
 
 Ensure your Python application has read and write access to the "results" directory.