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
 
Floppy (author)
Sun May 17 12:05:27 -0700 2009
commit  5510ce619d983bf241232cc3ce1e87b25777882a
tree    2d1f058376a53dc55971261b9057af87fc512e67
parent  d1d09bae891fd94236395d31ab746569534d1fb4
eeml-ruby / README
100644 38 lines (24 sloc) 1.238 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
== 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://docs.github.com/Floppy/eeml-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-eeml
 
== 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.