Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pstuteville committed Sep 24, 2010
1 parent 5c9339b commit d9c9e26
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.rdoc
@@ -1,15 +1,21 @@
== Magento ===================
== Magento
Simple wrapper for the Magento XMLRPC api

Magento api documentation: http://www.magentocommerce.com/support/magento_core_api


== Usage =====================
== Usage
Setup your connection to magento with the following call:

Magento::Base.connection = Magento::Connection.new({:username => 'username', :api_key => 'api_key', :host => 'magento.example.org', :path => '/magento/api/xmlrpc', :port => '80'})

== License =====================
Magento::Customer.list
Magento::Product.info(1).sku
customer = Magento::Customer.find(:first, {:email => 'example@magentor.ccc'})
customer.update_attributes({:firstname => 'duke', :lastname => 'magentor'})
customer.delete

== License
Copyright (c) 2010 Preston Stuteville and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down

0 comments on commit d9c9e26

Please sign in to comment.