public
Description: A Ruby wrapper around the Extended Environments Markup Language
Homepage: http://github.com/Floppy/eeml-ruby
Clone URL: git://github.com/Floppy/eeml-ruby.git
name age message
file .gitignore Fri Aug 22 08:59:24 -0700 2008 ignore generated files [Floppy]
file COPYING Fri Aug 22 09:50:10 -0700 2008 Added documentation and utility files [Floppy]
file README Sun Nov 15 07:46:07 -0800 2009 update doc link seeing as docs.github.com has died [James Smith]
file Rakefile Fri Aug 22 09:50:10 -0700 2008 Added documentation and utility files [Floppy]
file eeml-ruby.gemspec Sun Nov 15 07:42:30 -0800 2009 rename gem to eeml-simple to avoid conflict on ... [James Smith]
directory examples/ Sun Nov 15 07:13:09 -0800 2009 added ID parameter to data item in example [James Smith]
directory lib/ Sun Nov 15 07:11:53 -0800 2009 add support for explicit setting of ID for data... [James Smith]
directory spec/ Sun Nov 15 07:11:53 -0800 2009 add support for explicit setting of ID for data... [James Smith]
README
== EEML-Ruby

A Ruby wrapper around the Extended Environments Markup Language
(http://www.eeml.org)

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

Author: James Smith (james@floppy.org.uk / http://www.floppy.org.uk)

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

Documentation: http://rdoc.info/projects/Floppy/eeml-ruby

== INSTALLATION

1) Enable gems from gemcutter, if you haven't already done so:
    > sudo gem install gemcutter
    > sudo gem tumble

2) Install gem
    > sudo gem install eeml-simple

== STATUS

The code can current create EEML at a level equivalent to the
"complete" EEML example at http://eeml.org/xml/005/complete.xml, and parse the
"minimal" level at http://eeml.org/xml/005/minimal.xml

To parse EEML: call EEML::Environment#from_eeml(your_eeml_string), and you will
get back an EEML::Environment object containing a number of EEML::Data objects.

To create EEML: create an EEML::Environment object, add one or more EEML::Data
objects to it, and call EEML::Environment#to_eeml.

== EXAMPLES

The file examples/simple_server.rb contains a simple WEBrick server which serves
an EEML document. This allows a site like Pachube (http://www.pachube.com) to
fetch EEML data from your system.