README.rdoc in sitemap-0.1b2 vs README.rdoc in sitemap-0.1
- old
+ new
@@ -1,12 +1,26 @@
= Sitemap
A simple ruby on rails sitemap generator.
+== Instalation
+
+Install the gem:
+
+ gem install sitemap
+
+Or as a plugin:
+
+ rails plugin install git://github.com/viseztrance/rails-sitemap.git
+
+Then create the initial config file:
+
+ rails g sitemap:install
+
== Usage
-Create a sitemap.rb file in your config directory. Paths can be indexed as follows:
+In your sitemap config file, paths can be indexed as follows:
Sitemap::Generator.instance.load :host => "mywebsite.com" do
path :root, :priority => 1
path :faq, :priority => 0.5, :change_frequency => "weekly"
resources :activities, :params => { :format => "html" }
@@ -20,9 +34,19 @@
rake sitemap:generate
Ping search engines:
rake sitemap:ping
+
+== Setting defaults
+
+You may change the defaults for either <tt>params</tt> or <tt>search</tt> options as follows:
+
+ Sitemap.defaults[:params] = { :format => "html" }
+
+== Limitations
+
+Sitemaps can only have up to 50000 urls and an uncompressed size of 10MB. This issue will be resolved in a future release.
== License
This package is licensed under the MIT license and/or the Creative
Commons Attribution-ShareAlike.
\ No newline at end of file