Show
Ignore:
Timestamp:
06/16/08 00:39:34 (7 months ago)
Author:
Mark Guzman <segfault@…>
Parents:
a07cd646109e84174fa21b208e7ff9425d77a22b
Children:
5353e67fcde7173f0708e67d2f9f1ff0d8eba7d6
git-committer:
Mark Guzman <segfault@hasno.info> / 2008-06-16T00:39:34Z-0400
Message:

refactored away the Include modules, so that we get documentation of the
ruby-side code alongside the c code
updated the readme to mention licensing and copyright along with a usage
example

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • README

    ra07cd6 r4c4a11  
    1 = FastXml, a simple fast xml library using libxml and libxslt 
     1= FastXml 
     2a simple fast xml library using libxml and libxslt with an hpricot-like api 
    23 
    34== Overview 
    45 
    5 FastXml is:  
     6FastXml:  
    67 
    7 # not standalone, it *requires libxml* and *libxslt* 
    8 # it attempts to provide the speediest xml parsing library available for ruby 
    9 # it provides an hpricot-like syntax for xml parsing and xslt processing 
     8 1) is not standalone, it *requires libxml* and *libxslt* 
     9 2) attempts to provide the speediest xml parsing library available for ruby 
     10 3) provides an hpricot-like syntax for xml parsing and xslt processing 
     11 
     12== Example 
     13 doc = FastXml( open( 'test.xml ) ) 
     14 puts doc.root.name 
     15 puts doc.root.content 
     16  
     17 doc.root.children.each do |node| 
     18   puts "%s => %s" % [ node.name, node.content ] 
     19 end 
     20 
     21 (doc/"/node").each { |node| puts node.inspect } #xpath search 
     22 doc.search( "//node" ).each { |node| puts node.inspect }  
     23 
     24 
     25== Copyright & Licensing 
     26Copyright Mark Guzman 2007-2008 
     27 
     28Please see the LICENSE file for more details. The short version is it's under the same terms as Ruby.