README.md in xml-sitemap-1.1.2 vs README.md in xml-sitemap-1.1.3

- old
+ new

@@ -1,40 +1,65 @@ -XmlSitemap -========== +# XmlSitemap XmlSitemap is a Ruby library that provides an easy way to generate XML sitemaps and indexes. -It does not have any web-framework dependencies thus might be used almost anywhere. +It does not have any web-framework dependencies and could be used in any ruby-based application. -## Installing XmlSitemap +## Installation +Install via rubygems: + $ gem install xml-sitemap -## Sample usage +## Configuration -In your Gemfile: +Add gem to your Gemfile and you're ready to go: - gem 'xml-sitemap' +```ruby +gem 'xml-sitemap' +``` + +## Usage -Simple map usage: +Simple usage: - map = XmlSitemap::Map.new('domain.com') do |m| - # Adds a simple page - m.add '/page1' - - # You can drop leading slash, it will be automatically added - m.add 'page2' - - # Set the page priority - m.add 'page3', :priority => 0.2 - - # Specify last modification date and update frequiency - m.add 'page4', :updated => Date.today, :period => :never - end - - map.render # => render to XML - map.render_to('/path/to/file.xml') # => render into a file +```ruby +map = XmlSitemap::Map.new('domain.com') do |m| + # Adds a simple page + m.add '/page1' + + # You can drop leading slash, it will be automatically added + m.add 'page2' + + # Set the page priority (default is 0.5) + m.add 'page3', :priority => 0.2 + + # Specify last modification date and update frequiency + m.add 'page4', :updated => Date.today, :period => :never +end + +# Render the sitemap XML +map.render + +# Render and save XML to the output file +map.render_to('/path/to/file.xml') + +# You can also use compression +map.render_to('/path/to/file.xml.gz', :gzip => true) + +# If you didnt specify .gz extension to the filename, +# XmlSitemap will automatically append it +# => content will be saved to /path/to/file.xml.gz +map.render_to('/path/to/file.xml', :gzip => true) +``` + +You can also create a map via shortcut: + +```ruby +map = XmlSitemap.new('foobar.com') +map = XmlSitemap.map('foobar.com') +``` By default XmlSitemap creates a map with link to homepage of your domain. It's a priority 1.0. Default priority is 0.5. List of periods: @@ -49,41 +74,50 @@ ## XmlSitemap::Map When creating a new map object, you can specify a set of options. - map = XmlSitemap::Map.new('mydomain.com', options) +```ruby +map = XmlSitemap::Map.new('mydomain.com', options) +``` Available options: -- :secure - Will add all sitemap items with https prefix. (default: false) -- :home - Disable homepage autocreation, but you still can do that manually. (default: true) -- :root - Force all links to fall under the main domain. You can add full urls (not paths) if set to false. (default: true) +- :secure - Will add all sitemap items with https prefix. *(default: false)* +- :home - Disable homepage autocreation, but you still can do that manually. *(default: true)* +- :root - Force all links to fall under the main domain. You can add full urls (not paths) if set to false. *(default: true)* - :time - Provide a creation time for the sitemap. (default: current time) +- :group - Group name for sitemap index. *(default: sitemap)* ## XmlSitemap::Index -Regular sitemap does not support more than 50k records, so if you generation a huge sitemap you need to use XmlSitemap::Index. +Regular sitemap does not support more than 50k records, so if you're generating a huge sitemap you need to use XmlSitemap::Index. + Index is just a collection of links to all the website's sitemaps. Usage: - map = XmlSitemap::Map.new('domain.com') - map.add 'page' +```ruby +map = XmlSitemap::Map.new('domain.com') +map.add 'page' - index = XmlSitemap::Index.new - index.add map - - index.render # => render index to XML - index.render_to('/path/to/file.xml') # => render into a file - -## TODO +index = XmlSitemap::Index.new +# or via shortcut +index = XmlSitemap.index -- Gzip sitemaps and index file +# Add a map to the index +index.add(map) +# Render as XML +index.render + +# Render XML to the output file +index.render_to('/path/to/file.xml') +``` + ## License -Copyright © 2010 Dan Sosedoff. +Copyright © 2010-2011 Dan Sosedoff. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. \ No newline at end of file