Contents

== AMEE-Ruby

A gem to provide a Ruby interface to the AMEE carbon calculator (http://amee.cc)

Licensed under the MIT license (See COPYING file for details)

Author: James Smith ([e-mail] / http://www.floppy.org.uk)

Homepage: http://github.com/Floppy/amee-ruby

== INSTALLATION

1) Enable gems from github, if you haven't already done so (rubygems >= 1.2): 
    > sudo gem sources -a http://gems.github.com

2) Install gem
    > sudo gem install Floppy-amee

== USAGE

Currently, you can read DataCategories, DataItems and DataItemValues. See 
examples/view_data_*.rb for simple usage examples. You can also get the list
of available Profiles. See examples/list_profiles.rb for details.

The gem will use the AMEE JSON API if the JSON gem is installed on the local
system. Otherwise the XML API will be used.

== INTERACTIVE SHELL

You can use the 'ameesh' app to interactively explore the AMEE data area. Run
'ameesh -u USERNAME -p PASSWORD -s SERVER' to try it out. Source code for this 
tool is in bin/ameesh and lib/amee/shell.rb. Profiles are not accessible through
this interface yet.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
Floppy-amee-0.2.1	README