adding more information to the README.rdoc file

albertobraschi · Sep 30, 2009 · 5e82b10 · 5e82b10
1 parent 7f9077d
commit 5e82b10
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 2 deletions.
diff --git a/README.rdoc b/README.rdoc
@@ -2,11 +2,28 @@
 
 This is a simple gem which wraps Magento XMLRPC calls with Ruby classes.
 This allows for you to integrate your Magento Shopping Cart into your Rails Application.
+This is not fully tested and some functionality is a WIP.
 
 == Usage =====================
 
-See Rdoc
+Edit config/config.yml and add your magento api username and api key to the file.
+
 
 == Issues ====================
 
 A patch needs to be applied to XMLRPC for this to work.
+
+Locate the xmlrpc gem on your system.
+
+Edit the parser.rb file
+
+Around line 509
+
+change to this
+
+when "nil"
+  raise "wrong/unknown XML-RPC type 'nil'" unless Config::ENABLE_NIL_PARSER
+  @value = :nil
+
+This allows for nil values to be handled by the parser.
+This bug exists due to the Magento api's handling of the responses.
diff --git a/pkg/magento-api-0.1.0/README.rdoc b/pkg/magento-api-0.1.0/README.rdoc
@@ -2,11 +2,28 @@
 
 This is a simple gem which wraps Magento XMLRPC calls with Ruby classes.
 This allows for you to integrate your Magento Shopping Cart into your Rails Application.
+This is not fully tested and some functionality is a WIP.
 
 == Usage =====================
 
-See Rdoc
+Edit config/config.yml and add your magento api username and api key to the file.
+
 
 == Issues ====================
 
 A patch needs to be applied to XMLRPC for this to work.
+
+Locate the xmlrpc gem on your system.
+
+Edit the parser.rb file
+
+Around line 509
+
+change to this
+
+when "nil"
+  raise "wrong/unknown XML-RPC type 'nil'" unless Config::ENABLE_NIL_PARSER
+  @value = :nil
+
+This allows for nil values to be handled by the parser.
+This bug exists due to the Magento api's handling of the responses.