Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

README modified

  • Loading branch information...
commit 486c52580e7f5c54654b1d9a569809fd43209b57 1 parent 87caf54
@afiskon authored
Showing with 40 additions and 12 deletions.
  1. +39 −11 README
  2. +1 −1  lib/Sitemap/XML/Parser.pm6
View
50 README
@@ -1,15 +1,43 @@
-A Perl 6 module for parsing sitemap.xml files.
+NAME
-All files (unless noted otherwise) can be used, modified and redistributed
-under the terms of the Artistic License Version 2.
+Sitemap::XML::Parser is a module for parsing sitemap.xml files.
-To build and test this module, plese get 'ufo' from
-http://github.com/masak/ufo and run
+SYNOPSYS
- ufo
- make
- make test
- make install
+ use Sitemap::XML::Parser;
+
+ my $parser = Sitemap::XML::Parser.new;
+ my $sitemap = $parser.parse-url('http://example.ru/sitemap.xml');
+ # $sitemap == [
+ # {
+ # loc => URI.new('http://example/'),
+ # lastmod => DateTime.new('2012-09-06T03:22:42Z'),
+ # changefreq => 'daily',
+ # priority => 1.0
+ # },
+ # ....
+ # ];
+
+
-Credits
- Alexandr Alexeev <afiskon@gmail.com>
+DESCRIPTION
+
+Module for parsing sitemap.xml files.
+
+METHODS
+
+ parse-url( Str $url )
+
+ parse-file( Str $fname )
+
+ parse( Str $data )
+
+AUTHOR
+
+Alexandr Alexeev, <eax at cpan.org> (http://eax.me/)
+
+COPYRIGHT
+
+Copyright 2012 Alexandr Alexeev
+
+This program is free software; you can redistribute it and/or modify it under the same terms as Rakudo Perl 6 itself.
View
2  lib/Sitemap/XML/Parser.pm6
@@ -111,7 +111,7 @@ my $sitemap = $parser.parse-url('http://example.ru/sitemap.xml');
=head1 DESCRIPTION
-Module for parsing sitemap.xml files
+Module for parsing sitemap.xml files.
=head1 METHODS
Please sign in to comment.
Something went wrong with that request. Please try again.