Skip to content

Commit

Permalink
Updated README: See the new QuickBooks® gem at http://www.behindlogic…
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Parker committed Feb 7, 2009
1 parent 2cfb3bf commit 906d5bc
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README → README.textile
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
== THIS IS A PRELIMINARY VERSION!
h2. THIS IS A PRELIMINARY VERSION!

This is an early version of the QuickBooks RubyGem, and it has been completely rewritten from the ground up. The new version is actually generated from QuickBooks' QBXML DTDs, and therefore comprehensively covers the entire QuickBooks API. Please contact gems@behindlogic.com for information about the new rubygem.
This is an early version of the QuickBooks RubyGem, and has since been completely rewritten from the ground up. The new version is actually "generated from QuickBooks' QBXML DTDs":http://blog.behindlogic.com/2009/01/quickbooks-rubygem-meta-meta-ruby.html, and therefore comprehensively covers the entire QuickBooks API. To read more, head over to "http://www.behindlogic.com":http://www.behindlogic.com or contact gems [at] behindlogic.com.

== Welcome to QuickBooks for Ruby
h1. Welcome to QuickBooks for Ruby

The purpose of this gem is to perform connectivity and communication with Quickbooks, providing the user with access to quickbooks data as everyday ruby objects. This could be understood to be somewhat like an ORM, but it is different in that its models are predefined by the Quickbooks API.

In releases prior to 0.1.0, some knowledge of the Quickbooks API may be required. In releases beyond 0.1.0, the Quickbooks API should be fully hidden from your view.

Enjoy and PLEASE contribute either by suggestion or by submitting patches, etc. Or if development seems slow, please feel free to join! My work on this project has been solely for my own use of the gem, while opening up its achievements for others to use as well. Development may slow down considerably when I find it is at a stable and usable point for my needs. You've been warned! ;)

== Download
h2. Download

* http://github.com/dcparker/quickbooks
* git clone git://github.com/dcparker/quickbooks.git

== Status
h2. Status

This library is a work in progress. This package is separated into two distinct components: Qbxml and Quickbooks (models). The Qbxml represents most of the work of complying to the Quickbooks SDK, and is useful separate from the Quickbooks portion, for use with the QB Web Connector or QB Online Edition (as this gem does not support these connection types yet). For now, The Web Connector is NOT in plans to be supported as it requires additional logic of a different kind in asynchronous network communication.

Furthermore, as of version 0.1.0, the Customer model is the only model fleshed out and in working condition. It is rather stable, but please report any bugs you find. I have attempted to make the Quickbooks family of models to work much like DataMapper models, with their finder methods and such. It may be possible to make this gem into a DataMapper adapter.

== Usage
h2. Usage

Simply include this gem in your project:
require 'rubygems'
Expand All @@ -38,7 +38,7 @@ Read further in Qbxml::Request and Qbxml::Response in order to get a better unde

Again, until a later version, you will need to be running Quickbooks on the same computer _and have quickbooks open_ to the company file you need. The first time you run your script, you will need to authorize access to your script when Quickbooks asks you to.

== Authors
h2. Authors

* Chris Bruce (mailto:chrisabruce@yahoo.com)
* Daniel Parker (mailto:gems@behindlogic.com)
Expand Down

0 comments on commit 906d5bc

Please sign in to comment.