sitemap_generator 5.2.0 → 5.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDE5YzhmMzI3Mzk0ZDIxNGExNjk5OTE5MTMxMTZiYzQ1NjY2NzA5NQ==
+    N2IwNTliN2E5Y2EwMzhlNzk3NzU5MTE5MzUwYzcwODA1OTU2N2VhOA==
   data.tar.gz: !binary |-
-    MTY1OTNhMWE4ZWNiN2JjMzU0ZTUzYzAyZjJhNmE5ZTQ4NjM1MDVkYw==
+    NjBmN2FmZGIwYWRjMmQ4Mzc1NDlmZTc0Njg0ZTFiNTY1ZmRlZjdlNA==
 SHA512:
   metadata.gz: !binary |-
-    N2NhNmU1OWUwMWM3NTMyMDhmZmU3MmI4NDJjMWYyOWZmOGMzNTkxZTBmMzA0
-    Nzk1M2VjZWU2YzdhZmNkOWYwNDZmY2Q5OWQ0MzAxM2MyYTBhMjhkNjczYTZk
-    NzczMzVkNDhmY2I5OTU2MTFlNTNmN2JlYzRiNmJiOTkzOTc4ZWM=
+    M2IzOGIxMDQ0MjM0NWI4ZDA5MDNiNTgwMzA0MWQ5NTFiMGI0NmVkNzNhZGY1
+    M2FkYzYxZDY4YjgzMzIzYmY2YTliMThlNzY2ZTFkZmM4MDI3ZTA2NzI4MTZm
+    OTQzNGQ5ZDhhMWM0ZDliOTVjMGEyZDIyNTlkZjUyM2E5NDM3ZGQ=
   data.tar.gz: !binary |-
-    ZGNiZjJkMzI0ZmViZmM3OTk4MTFmYWQ4YTA5OWY4ODIzMWQyYWMxMzQ3ZmYw
-    OGY2NTdkNzY5YWJkZGJiNTc1MTVkOWFhYTM1MDZjMjczZjI3MWU1ODIwNjZm
-    MjUyNjc4OTRkMWIwMDZjNDBmOGYzZDAzZTgzYjE2NGU3M2E0ZmY=
+    MGYxNTM3NTNhMzI3MjFlZGRjOTg2NmJlYWMyMjg5YmRkNTg0OGI3Y2IyNzBk
+    MDUyZWEzZjE3NWIwZjdmMjBmMWNmZmEwMDBmMDU5ODMzMGY2ODE5ZDc3NWQ3
+    YzQ1Zjg3MThmMjJiMzg2ODQ1Yjk5ODQ2YzJjMzRlMjUyNGNhZTU=

data/CHANGES.md

@@ -0,0 +1,250 @@
+### 5.3.0
+
+* Add `max_sitemap_links` option support for limiting how many links each sitemap can hold.  Issue [#188](https://github.com/kjvarga/sitemap_generator/issues/188) PR [#262](https://github.com/kjvarga/sitemap_generator/pull/262)
+* Upgrade development dependencies
+* Modernize Gemfile & gemspec
+* Bring specs up to RSpec 3.5
+* Remove Geo sitemap support.  Google no longer supports them. Issue [#246](https://github.com/kjvarga/sitemap_generator/issues/246)
+* Use `sitemap` namespace for Capistrano tasks (rather than `deploy`). PR [#241](https://github.com/kjvarga/sitemap_generator/pull/241)
+* Use presence of `Rails::VERSION` to detect when running under Rails, rather than just `Rails` constant.  PR [#221](https://github.com/kjvarga/sitemap_generator/pull/221)
+* Remove gem post-install message warning about incompatible changes in version 4
+
+### 5.2.0
+
+* New `SitemapGenerator::AwsSdkAdapter` adapter using the bare aws-sdk gem.
+* Fix Bing ping url.
+* Support string option keys passed to `add`.
+* In Railtie, Load the rake task instead of requiring them.
+
+### 5.1.0
+
+* Require only `fog-aws` instead of `fog` for the `S3Adapter` and support using IAM profile instead of setting access key & secret directly.
+* Implement `respond_to?` on the `SitemapGenerator::Sitemap` pseudo class.
+* Make `:lang` optional on alternate links so they can be used for [AppIndexing](https://developers.google.com/app-indexing/reference/deeplinks).
+* Documented Mobile Sitemaps `:mobile` option.
+
+### 5.0.5
+
+* Use MIT licence.
+* Fix deploys with Capistrano 3 ([#163](https://github.com/kjvarga/sitemap_generator/issues/163)).
+* Allow any Fog storage options for S3 adapter ([#167](https://github.com/kjvarga/sitemap_generator/pull/167)).
+
+### 5.0.4
+
+* Don't include the `media` attribute on alternate links unless it's given
+
+### 5.0.3
+
+* Add support for Video sitemaps options `:live` and ':requires_subscription'
+
+### 5.0.2
+
+* Set maximum filesize to 10,000,000 bytes rather than 10,485,760 bytes.
+
+### 5.0.1
+
+* Include new `SitemapGenerator::FogAdapter` ([#138](https://github.com/kjvarga/sitemap_generator/pull/138)).
+* Fix usage of attr_* methods in `LinkSet`
+* Don't override custom getters/setters ([#144](https://github.com/kjvarga/sitemap_generator/pull/144)).
+* Fix breaking spec in Ruby 2 ([#142](https://github.com/kjvarga/sitemap_generator/pull/142)).
+* Include Capistrano 3.x tasks ([#141](https://github.com/kjvarga/sitemap_generator/pull/141)).
+
+### 5.0.0
+
+* Support new `:compress` option for customizing which files get compressed.
+* Remove old deprecated methods:
+    * Removed options to `LinkSet::add()`: `:sitemaps_namer` and `:sitemap_index_namer` (use `:namer` option)
+    * Removed `LinkSet::sitemaps_namer=`, `LinkSet::sitemaps_namer` (use `LinkSet::namer=` and `LinkSet::namer`)
+    * Removed `LinkSet::sitemaps_index_namer=`, `LinkSet::sitemaps_index_namer` (use `LinkSet::namer=` and `LinkSet::namer`)
+    * Removed the `SitemapGenerator::SitemapNamer` class (use `SitemapGenerator::SimpleNamer`)
+    * Removed `LinkSet::add_links()` (use `LinkSet::create()`)
+* Support `fog_path_style` option in the `SitemapGenerator::S3Adapter` so buckets with dots in the name work over HTTPS without SSL certificate problems.
+
+### 4.3.1
+
+* Support integer timestamps.
+* Update README for new features added in last release.
+
+### 4.3.0
+
+* Support `media` attibute on alternate links ([#125](https://github.com/kjvarga/sitemap_generator/issues/125)).
+* Changed `SitemapGenerator::S3Adapter` to write files in a single operation, avoiding potential permissions errors when listing a directory prior to writing ([#130](https://github.com/kjvarga/sitemap_generator/issues/130)).
+* Remove Sitemap Writer from ping task ([#129](https://github.com/kjvarga/sitemap_generator/issues/129)).
+* Support `url:expires` element ([#126](https://github.com/kjvarga/sitemap_generator/issues/126)).
+
+### 4.2.0
+
+* Update Google ping URL.
+* Quote the ping URL in the output.
+* Support Video `video:price` element ([#117](https://github.com/kjvarga/sitemap_generator/issues/117)).
+* Support symbols as well as strings for most arguments to `add()` ([#113](https://github.com/kjvarga/sitemap_generator/issues/113)).
+* Ensure that `public_path` and `sitemaps_path` end with a slash (`/`) ([#113](https://github.com/kjvarga/sitemap_generator/issues/118)).
+
+### 4.1.1
+
+* Support setting the S3 region.
+* Fixed bug where incorrect URL was being used in the ping to search engines - only affected sites with a single sitemap file and no index file.
+* Output the URL being pinged in the verbose output.
+* Test in Rails 4.
+
+### 4.1.0
+
+* [PageMap sitemap][using_pagemaps] support.
+* Tested with Rails 4 pre-release.
+
+### 4.0.1
+
+* Add a post install message regarding the naming convention change.
+
+### 4.0
+
+* **NEW, NON-BACKWARDS COMPATIBLE CHANGES.**
+* `create_index` defaults to `:auto`.
+* Define `SitemapGenerator::SimpleNamer` class for simpler custom namers compatible with the new naming conventions.
+* Deprecate `sitemaps_namer`, `sitemap_index_namer` and their respective namer classes.
+* Support `nofollow` option on alternate links.
+* Fix formatting of `publication_date` in News sitemaps.
+
+### 3.4
+
+* Support [alternate links][alternate_links] for urls
+* Support configurable options in the `SitemapGenerator::S3Adapter`
+
+### 3.3
+
+* Support creating sitemaps with no index file
+
+### 3.2.1
+
+* Fix syntax error in `SitemapGenerator::S3Adapter`
+
+### 3.2
+
+* Support mobile tags
+* Add `SitemapGenerator::S3Adapter`, a simple S3 adapter which uses Fog and doesn't require CarrierWave
+* Remove Ask from the sitemap ping because the service has been shutdown
+* [Turn off `include_index`][include_index_change] by default
+* Fix the news XML namespace
+* Only include `autoplay` attribute if present
+
+### 3.1.1
+
+* Bugfix
+* Groups inherit current adapter
+
+### 3.1.0
+
+* Add `add_to_index` method to add links to the sitemap index.
+* Add `sitemap` method for accessing the `LinkSet instance from within `create()`.
+* Don't modify options hashes passed to methods.  Fix and improve `yield_sitemap` option handling.
+
+### 3.0.0
+
+* **Framework agnostic!**
+* Fix alignment in output
+* Show directory sitemaps are being generated into
+* Only show sitemap compressed file size
+* Toggle output using VERBOSE environment variable
+* Remove tasks/ directory because it's deprecated in Rails 2
+* Simplify dependencies.
+
+### 2.2.1
+
+* Support adding new search engines to ping and modifying the default search engines.
+* Allow the URL of the sitemap index to be passed as an argument to `ping_search_engines`. See Pinging Search Engines in README.
+
+### 2.1.8
+
+* Extend and improve Video Sitemap support.
+* Include sitemap docs in the README, support all element attributes, properly format values.
+
+### 2.1.7
+
+* Improve format of float priorities
+* Remove Yahoo from ping - the Yahoo service has been shut down.
+
+### 2.1.6
+
+* Fix the `lastmod` value on sitemap file links
+
+### 2.1.5
+
+* Fix verbose setting in the rake task, it should default to true
+
+### 2.1.4
+
+* Allow special characters in URLs (don't use `URI.join` to construct URLs)
+
+### 2.1.3
+
+* Fix calling `create` with both `filename` and `sitemaps_namer` options
+
+### 2.1.2
+
+* Support multiple videos per url using the new `videos` option to `add()`.
+
+### 2.1.1
+
+* Support calling `create()` multiple times in a sitemap config
+* Support host names with path segments so you can use a `default_host` like `'http://mysite.com/subdirectory/'`
+* Turn off `include_index` when the `sitemaps_host` differs from `default_host`
+* Add docs about how to upload to remote hosts.
+
+### 2.1.0
+
+* [News sitemap][sitemap_news] support
+
+### 2.0.1.pre2
+
+* Fix uploading to the (bucket) root on a remote server
+
+### 2.0.1.pre1
+
+* Support read-only filesystems like Heroku by supporting uploading to remote host
+
+### 2.0.1
+
+* Minor improvements to verbose handlig
+* Prevent missing `Timeout` issue
+
+### v2.0.0
+
+* Introducing a new simpler API, Sitemap Groups, Sitemap Namers and more!
+
+### 1.5.0
+
+* New options `include_root`, `include_index`
+* Major testing & refactoring
+
+### 1.4.0
+
+* [Geo sitemap][geo_tags] support
+* Multiple sitemap support via CONFIG_FILE rake option
+
+### 1.3.0
+
+* Support setting the sitemaps path
+
+### 1.2.0
+
+* Verified working with Rails 3 stable release
+
+### 1.1.0
+
+* [Video sitemap][sitemap_video] support
+
+### 0.2.6
+
+* [Image Sitemap][sitemap_images] support
+
+### 0.2.5
+
+* Rails 3 prerelease support (beta)
+
+[geo_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=94555
+[sitemap_images]:http://www.google.com/support/webmasters/bin/answer.py?answer=178636
+[sitemap_video]:https://support.google.com/webmasters/answer/80471?hl=en&ref_topic=4581190
+[sitemap_news]:https://support.google.com/news/publisher/topic/2527688?hl=en&ref_topic=4359874
+[include_index_change]:https://github.com/kjvarga/sitemap_generator/issues/70
+[alternate_links]:http://support.google.com/webmasters/bin/answer.py?hl=en&answer=2620865
+[using_pagemaps]:https://developers.google.com/custom-search/docs/structured_data#pagemaps

data/README.md

@@ -7,9 +7,9 @@ Sitemaps adhere to the [Sitemap 0.9 protocol][sitemap_protocol] specification.
 ## Features
 
 * Framework agnostic
-* Supports [News sitemaps][sitemap_news], [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], [Geo sitemaps][sitemap_geo], [Mobile sitemaps][sitemap_mobile], [PageMap sitemaps][sitemap_pagemap] and [Alternate Links][alternate_links]
+* Supports [News sitemaps][sitemap_news], [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], [Mobile sitemaps][sitemap_mobile], [PageMap sitemaps][sitemap_pagemap] and [Alternate Links][alternate_links]
 * Supports read-only filesystems like Heroku via uploading to a remote host like Amazon S3
-* Compatible with Rails 2, 3 & 4 and tested with Ruby REE, 1.9.2 & 1.9.3
+* Compatible with Rails 2, 3 & 4 and tested with Ruby REE, 1.9.2, 1.9.3, 2.1.3
 * Adheres to the [Sitemap 0.9 protocol][sitemap_protocol]
 * Handles millions of links
 * Customizable sitemap compression
@@ -59,6 +59,69 @@ Successful ping of Google
 Successful ping of Bing
 ```
 
+## Index
+
+   * [SitemapGenerator](#sitemapgenerator)
+      * [Features](#features)
+         * [Show Me](#show-me)
+      * [Contribute](#contribute)
+      * [Foreword](#foreword)
+      * [Install](#install)
+         * [Ruby](#ruby)
+         * [Rails](#rails)
+      * [Getting Started](#getting-started)
+         * [Preventing Output](#preventing-output)
+         * [Rake Tasks](#rake-tasks)
+         * [Pinging Search Engines](#pinging-search-engines)
+         * [Crontab](#crontab)
+         * [Robots.txt](#robotstxt)
+         * [Ruby Modules](#ruby-modules)
+      * [Deployments & Capistrano](#deployments--capistrano)
+         * [Sitemaps with no Index File](#sitemaps-with-no-index-file)
+         * [Upload Sitemaps to a Remote Host using Adapters](#upload-sitemaps-to-a-remote-host-using-adapters)
+            * [Supported Adapters](#supported-adapters)
+         * [Generating Multiple Sitemaps](#generating-multiple-sitemaps)
+      * [Sitemap Configuration](#sitemap-configuration)
+         * [A Simple Example](#a-simple-example)
+         * [Adding Links](#adding-links)
+         * [Supported Options to add](#supported-options-to-add)
+         * [Adding Links to the Sitemap Index](#adding-links-to-the-sitemap-index)
+         * [Accessing the LinkSet instance](#accessing-the-linkset-instance)
+         * [Speeding Things Up](#speeding-things-up)
+      * [Customizing your Sitemaps](#customizing-your-sitemaps)
+         * [Sitemap Options](#sitemap-options)
+      * [Sitemap Groups](#sitemap-groups)
+         * [A Groups Example](#a-groups-example)
+         * [Using `group` without a block](#using-group-without-a-block)
+      * [Sitemap Extensions](#sitemap-extensions)
+         * [News Sitemaps](#news-sitemaps)
+            * [Example](#example)
+            * [Supported options](#supported-options)
+         * [Image Sitemaps](#image-sitemaps)
+            * [Example](#example-1)
+            * [Supported options](#supported-options-1)
+         * [Video Sitemaps](#video-sitemaps)
+            * [Example](#example-2)
+            * [Supported options](#supported-options-2)
+         * [PageMap Sitemaps](#pagemap-sitemaps)
+            * [Supported options](#supported-options-4)
+            * [Example:](#example-4)
+         * [Alternate Links](#alternate-links)
+            * [Example](#example-5)
+            * [Supported options](#supported-options-5)
+         * [<a name="user-content-internal_mobile"></a> Mobile Sitemaps](#-mobile-sitemaps)
+            * [Example](#example-6)
+            * [Supported options](#supported-options-6)
+      * [Raison d'être](#raison-dêtre)
+      * [Compatibility](#compatibility)
+      * [Known Bugs](#known-bugs)
+      * [Deprecation Notices and Non-Backwards Compatible Changes](#deprecation-notices-and-non-backwards-compatible-changes)
+         * [Version 5.0.0](#version-500)
+         * [Version 4.0.0](#version-400)
+            * [So what has changed?](#so-what-has-changed)
+            * [I don't want it!  How can I keep everything as it was?](#i-dont-want-it--how-can-i-keep-everything-as-it-was)
+            * [I want it!  What do I need to do?](#i-want-it--what-do-i-need-to-do)
+      * [Thanks (in no particular order)](#thanks-in-no-particular-order)
 
 ## Contribute
 
@@ -66,103 +129,6 @@ Does your website use SitemapGenerator to generate Sitemaps?  Where would you be
 
 <a href='http://www.pledgie.com/campaigns/15267'><img alt='Click here to lend your support to: SitemapGenerator and make a donation at www.pledgie.com !' src='http://pledgie.com/campaigns/15267.png?skin_name=chrome' border='0' /></a>
 
-## Deprecation Notices and Non-Backwards Compatible Changes
-
-### Version 5.0.0
-
-In version 5.0.0 I've removed a few deprecated methods that have been deprecated for a long time.  The reason being that they would have made some new features more difficult and complex to implement.  I never actually ouput deprecation notices from these methods, so I understand it you're a little annoyed that your config has suddenly broken.  Apologies.
-
-Here's a list of the methods that have been removed:
-* Removed options to `LinkSet::add()`: `:sitemaps_namer` and `:sitemap_index_namer` (use `:namer` option)
-* Removed `LinkSet::sitemaps_namer=`, `LinkSet::sitemaps_namer` (use `LinkSet::namer=` and `LinkSet::namer`)
-* Removed `LinkSet::sitemaps_index_namer=`, `LinkSet::sitemaps_index_namer` (use `LinkSet::namer=` and `LinkSet::namer`)
-* Removed the `SitemapGenerator::SitemapNamer` class (use `SitemapGenerator::SimpleNamer`)
-* Removed `LinkSet::add_links()` (use `LinkSet::create()`)
-
-### Version 4.0.0
-
-Version 4.0 introduces a new **non-backwards compatible** naming scheme.  **If you are running version 3 or earlier and you upgrade to version 4, you need to make a couple small changes to ensure that search engines can still find your sitemaps!**  Your sitemaps will still work fine, but the name of the index file has changed.
-
-#### So what has changed?
-
-* **The index is generated intelligently**.  SitemapGenerator now detects whether you need an index or not, and only generates one if you need it or have requested it.  So small sites (less than 50,000 links) won't have one, large sites will.  You don't have to worry about anything.  And with the `create_index` option, it's easier than ever to control index creation to suit your needs.
-
-* **The default index file name has changed** from `sitemap_index.xml.gz` to just `sitemap.xml.gz`.  So the `_index` part has been removed.  This is a more standard naming scheme for the sitemaps. Any further sitemaps are named `sitemap1.xml.gz`, `sitemap2.xml.gz`, `sitemap3.xml.gz` etc, just as before.
-
-* **Everyone now points search engines to the `sitemap.xml.gz` file**.  It doesn't matter whether your site has 10 links or a million links, just point to `sitemap.xml.gz`.  If your site needs an index, that is the index.  If it doesn't, then that's your sitemap.  Simple.
-
-* **It's easier to write custom namers** because the index and the sitemaps share the same namer instance (which is now a `SitemapGenerator::SimpleNamer` instance).
-
-* **Groups share the new naming convention**.  So the files in your `geo` group will be named `geo.xml.gz`, `geo1.xml.gz`, `geo2.xml.gz` etc.  Pre-version 4 these files would have been named `geo1.xml.gz`, `geo2.xml.gz`, `geo3.xml.gz` etc.
-
-#### I don't want it!  How can I keep everything as it was?
-
-You don't care, you just want to get on with your day.  To resort to pre-version 4 behaviour add the following to your sitemap config:
-
-```ruby
-SitemapGenerator::Sitemap.create_index = true
-SitemapGenerator::Sitemap.namer = SitemapGenerator::SimpleNamer.new(:sitemap, :zero => '_index')
-```
-
-This tells SitemapGenerator to always create an index file and to name it `sitemap_index.xml.gz`.  If you are already using custom namers, you don't need to set `namer`; your old namers should still work as before.  If you are using named groups, setting the sitemap namer in this way won't affect your groups, which will still be using the new naming scheme.  If this is an issue for you, you may have to create namers for your groups.
-
-#### I want it!  What do I need to do?
-
-1. Update your `robots.txt` file and make sure it points to `sitemap.xml.gz`.
-2. Generate your sitemaps to create the new `sitemap.xml.gz` file.
-3. Optionally remove the old `sitemap_index.xml.gz` file (or link it to the new file if you want to make sure that search engines can find it while you update them.)
-4. Go to your Google Webmaster tools and other places where you've pointed search engines to your sitemaps and point them to your new `sitemap.xml.gz` file.
-
-That's it!  Welcome to the future!
-
-## Changelog
-
-* v5.2.0: New `SitemapGenerator::AwsSdkAdapter` adapter using the bare aws-sdk gem.  Fix Bing ping url.  Support string option keys passed to `add`.  In Railtie, Load the rake task instead of requiring them.
-* v5.1.0: Require only `fog-aws` instead of `fog` for the `S3Adapter` and support using IAM profile instead of setting access key & secret directly.  Implement `respond_to?` on the `SitemapGenerator::Sitemap` pseudo class.  Make `:lang` optional on alternate links so they can be used for [AppIndexing](https://developers.google.com/app-indexing/reference/deeplinks).  Documented [Mobile Sitemaps](#internal_mobile) `:mobile` option.
-* v5.0.5: Use MIT licence.  Fix deploys with Capistrano 3 ([#163](https://github.com/kjvarga/sitemap_generator/issues/163)).  Allow any Fog storage options for S3 adapter ([#167](https://github.com/kjvarga/sitemap_generator/pull/167)).
-* v5.0.4: Don't include the `media` attribute on alternate links unless it's given
-* v5.0.3: Add support for Video sitemaps options `:live` and ':requires_subscription'
-* v5.0.2: Set maximum filesize to 10,000,000 bytes rather than 10,485,760 bytes.
-* v5.0.1: Include new `SitemapGenerator::FogAdapter` ([#138](https://github.com/kjvarga/sitemap_generator/pull/138)).  Fix usage of attr_* methods in LinkSet; don't override custom getters/setters ([#144](https://github.com/kjvarga/sitemap_generator/pull/144)). Fix breaking spec in Ruby 2 ([#142](https://github.com/kjvarga/sitemap_generator/pull/142)).  Include Capistrano 3.x tasks ([#141](https://github.com/kjvarga/sitemap_generator/pull/141)).
-* v5.0.0: Support new `:compress` option for customizing which files get compressed.  Remove old deprecated methods (see deprecation notices above).  Support `fog_path_style` option in the `SitemapGenerator::S3Adapter` so buckets with dots in the name work over HTTPS without SSL certificate problems.
-* v4.3.1: Support integer timestamps.  Update README for new features added in last release.
-* v4.3.0: Support `media` attibute on alternate links ([#125](https://github.com/kjvarga/sitemap_generator/issues/125)).  Changed `SitemapGenerator::S3Adapter` to write files in a single operation, avoiding potential permissions errors when listing a directory prior to writing ([#130](https://github.com/kjvarga/sitemap_generator/issues/130)).  Remove Sitemap Writer from ping task ([#129](https://github.com/kjvarga/sitemap_generator/issues/129)).  Support `url:expires` element ([#126](https://github.com/kjvarga/sitemap_generator/issues/126)).
-* v4.2.0: Update Google ping URL.  Quote the ping URL in the output.  Support Video `video:price` element ([#117](https://github.com/kjvarga/sitemap_generator/issues/117)).  Support symbols as well as strings for most arguments to `add()` ([#113](https://github.com/kjvarga/sitemap_generator/issues/113)).  Ensure that `public_path` and `sitemaps_path` end with a slash (`/`) ([#113](https://github.com/kjvarga/sitemap_generator/issues/118)).
-* v4.1.1: Support setting the S3 region.  Fixed bug where incorrect URL was being used in the ping to search engines - only affected sites with a single sitemap file and no index file.  Output the URL being pinged in the verbose output.  Test in Rails 4.
-* v4.1.0: [PageMap sitemap][using_pagemaps] support.  Tested with Rails 4 pre-release.
-* v4.0.1: Add a post install message regarding the naming convention change.
-* **v4.0: NEW, NON-BACKWARDS COMPATIBLE CHANGES.**  See above for more info. `create_index` defaults to `:auto`.  Define `SitemapGenerator::SimpleNamer` class for simpler custom namers compatible with the new naming conventions.  Deprecate `sitemaps_namer`, `sitemap_index_namer` and their respective namer classes.  It's more just that their usage is discouraged.  Support `nofollow` option on alternate links.  Fix formatting of `publication_date` in News sitemaps.
-* v3.4: Support [alternate links][alternate_links] for urls; Support configurable options in the `SitemapGenerator::S3Adapter`
-* v3.3: **Support creating sitemaps with no index file**.  A big thank-you to [Eric Hochberger][ehoch] for generously paying for this feature.
-* v3.2.1: Fix syntax error in SitemapGenerator::S3Adapter
-* v3.2: **Support mobile tags**, **SitemapGenerator::S3Adapter** a simple S3 adapter which uses Fog and doesn't require CarrierWave; Remove Ask from the sitemap ping because the service has been shutdown; [Turn off `include_index`][include_index_change] by default; Fix the news XML namespace;  Only include autoplay attribute if present
-* v3.1.1: Bugfix: Groups inherit current adapter
-* v3.1.0: Add `add_to_index` method to add links to the sitemap index.  Add `sitemap` method for accessing the LinkSet instance from within `create()`.  Don't modify options hashes passed to methods.  Fix and improve `yield_sitemap` option handling.
-* **v3.0.0: Framework agnostic**; fix alignment in output, show directory sitemaps are being generated into, only show sitemap compressed file size; toggle output using VERBOSE environment variable; remove tasks/ directory because it's deprecated in Rails 2;  Simplify dependencies.
-* v2.2.1: Support adding new search engines to ping and modifying the default search engines.
-          Allow the URL of the sitemap index to be passed as an argument to `ping_search_engines`.  See **Pinging Search Engines**.
-* v2.1.8: Extend and improve Video Sitemap support.  Include sitemap docs in the README, support all element attributes, properly format values.
-* v2.1.7: Improve format of float priorities; Remove Yahoo from ping - the Yahoo
-          service has been shut down.
-* v2.1.6: Fix the lastmod value on sitemap file links
-* v2.1.5: Fix verbose setting in the rake tasks; should default to true
-* v2.1.4: Allow special characters in URLs (don't use URI.join to construct URLs)
-* v2.1.3: Fix calling create with both `filename` and `sitemaps_namer` options
-* v2.1.2: Support multiple videos per url using the new `videos` option to `add()`.
-* v2.1.1: Support calling `create()` multiple times in a sitemap config.  Support host names with path segments so you can use a `default_host` like `'http://mysite.com/subdirectory/'`.  Turn off `include_index` when the `sitemaps_host` differs from `default_host`.  Add docs about how to upload to remote hosts.
-* v2.1.0: [News sitemap][sitemap_news] support
-* v2.0.1.pre2: Fix uploading to the (bucket) root on a remote server
-* v2.0.1.pre1: Support read-only filesystems like Heroku by supporting uploading to remote host
-* v2.0.1: Minor improvements to verbose handling; prevent missing Timeout issue
-* **v2.0.0: Introducing a new simpler API, Sitemap Groups, Sitemap Namers and more!**
-* v1.5.0: New options `include_root`, `include_index`; Major testing & refactoring
-* v1.4.0: [Geo sitemap][geo_tags] support, multiple sitemap support via CONFIG_FILE rake option
-* v1.3.0: Support setting the sitemaps path
-* v1.2.0: Verified working with Rails 3 stable release
-* v1.1.0: [Video sitemap][sitemap_video] support
-* v0.2.6: [Image Sitemap][sitemap_images] support
-* v0.2.5: Rails 3 prerelease support (beta)
-
 
 ## Foreword
 
@@ -170,7 +136,7 @@ Adam Salter first created SitemapGenerator while we were working together in Syd
 
 Those who knew him know what an amazing guy he was, and what an excellent Rails programmer he was.  His passing is a great loss to the Rails community.
 
-The canonical repository is now: [http://github.com/kjvarga/sitemap_generator][canonical_repo]
+The canonical repository is: [http://github.com/kjvarga/sitemap_generator][canonical_repo]
 
 
 ## Install
@@ -311,9 +277,9 @@ require 'capistrano/sitemap_generator'
 Available capistrano tasks:
 
 ```ruby
-deploy:sitemap:create   #Create sitemaps without pinging search engines
-deploy:sitemap:refresh  #Create sitemaps and ping search engines
-deploy:sitemap:clean    #Clean up sitemaps in the sitemap path
+sitemap:create   #Create sitemaps without pinging search engines
+sitemap:refresh  #Create sitemaps and ping search engines
+sitemap:clean    #Clean up sitemaps in the sitemap path
 ```
 
   **Generate sitemaps into a directory which is shared by all deployments.**
@@ -537,7 +503,7 @@ Now let's take a look at the file that was created.  After uncompressing and XML
 
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
-<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1" xmlns:geo="http://www.google.com/geo/schemas/sitemap/1.0" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
+<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
   <url>
     <loc>http://www.example.com/</loc>
     <lastmod>2011-05-21T00:03:38+00:00</lastmod>
@@ -806,6 +772,8 @@ Because the link to the sitemap index file that would otherwise be added would p
 
   The compression setting applies to groups too.  So `:all_but_first` will have the same effect (the first file in the group will not be compressed, the rest will).  So if you require different behaviour for your groups, pass in a `:compress` option e.g. `group(:compress => false) { add('/link') }`
 
+* `:max_sitemap_links` - Integer. The maximum number of links to put in each sitemap.  Default is `SitemapGenerator::MAX_SITEMAPS_LINKS`, or 50,000.
+
 ## Sitemap Groups
 
 Sitemap Groups is a powerful feature that is also very simple to use.
@@ -860,6 +828,43 @@ The options you use when creating your groups will determine which and how many
 
 If you have changed your sitemaps physical location in a group, then the default sitemap will not be used and it will be unaffected by the group.  **Group sitemaps are finalized as they get full and at the end of each group.**
 
+### Using `group` without a block
+
+In some circumstances you may need to conditionally add records to a group or perform some other more complicated logic.  In these cases you can instantiate a group instance, add links to it and finalize it manually.
+
+When called with a block, any partial sitemaps are automatically written out for you when the block terminates.  Because this does not happen when instantiating manually, you must call `finalize!` on your group to ensure that it is written out and gets included in the sitemap index file.  Note that group sitemaps will still automatically be finalized (written out) as they become full; calling `finalize!` is to handle the case when a sitemap is not full.
+
+An example:
+
+```ruby
+SitemapGenerator::Sitemap.verbose = true
+SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+SitemapGenerator::Sitemap.create do
+  odds = group(:filename => :odds)
+  evens = group(:filename => :evens)
+
+  (1..20).each do |i|
+    if (i % 2) == 0
+      evens.add i.to_s
+    else
+      odds.add i.to_s
+    end
+  end
+
+  odds.finalize!
+  evens.finalize!
+end
+```
+
+And the output from running the above:
+
+```
+In '/Users/kvarga/Projects/sitemap_generator-test/public/':
++ odds.xml.gz                                             10 links /  371 Bytes
++ evens.xml.gz                                            10 links /  371 Bytes
++ sitemap.xml.gz                                        2 sitemaps /  240 Bytes
+Sitemap stats: 20 links / 2 sitemaps / 0m00s
+```
 
 ## Sitemap Extensions
 
@@ -973,24 +978,6 @@ end
     * `:live` - Optional. Boolean.
     * `:requires_subscription` - Optional. Boolean.
 
-### Geo Sitemaps
-
-Pages with geo data can be added by passing a `:geo` Hash to `add`.  The Hash only supports one tag of `:format`.  Google provides an [example of a geo sitemap link here][geo_tags].  Note that the sitemap does not actually contain your KML or GeoRSS.  It merely links to a page that has this content.
-
-#### Example:
-
-```ruby
-SitemapGenerator::Sitemap.default_host = "http://www.example.com"
-SitemapGenerator::Sitemap.create do
-  add('/stores/1234.xml', :geo => { :format => 'kml' })
-end
-```
-
-#### Supported options
-
-* `:geo` - Hash
-    * `:format` - Required, string, either `'kml'` or `'georss'`
-
 ### PageMap Sitemaps
 
 Pagemaps can be added by passing a `:pagemap` hash to `add`. The hash must contain a `:dataobjects` key with an array of dataobject hashes. Each dataobject hash contains a `:type` and `:id`, and an optional array of `:attributes`.  Each attribute hash can contain two keys: `:name` and `:value`, with string values.  For more information consult the [official documentation on PageMaps][using_pagemaps].
@@ -1114,8 +1101,54 @@ Tested and working on:
 * Currently only supports one Sitemap Index file, which can contain 50,000 Sitemap files which can each contain 50,000 urls, so it _only_ supports up to 2,500,000,000 (2.5 billion) urls.
 
 
-## Wishlist & Coming Soon
+## Deprecation Notices and Non-Backwards Compatible Changes
+
+### Version 5.0.0
+
+In version 5.0.0 I've removed a few deprecated methods that have been deprecated for a long time.  The reason being that they would have made some new features more difficult and complex to implement.  I never actually ouput deprecation notices from these methods, so I understand it you're a little annoyed that your config has suddenly broken.  Apologies.
+
+Here's a list of the methods that have been removed:
+* Removed options to `LinkSet::add()`: `:sitemaps_namer` and `:sitemap_index_namer` (use `:namer` option)
+* Removed `LinkSet::sitemaps_namer=`, `LinkSet::sitemaps_namer` (use `LinkSet::namer=` and `LinkSet::namer`)
+* Removed `LinkSet::sitemaps_index_namer=`, `LinkSet::sitemaps_index_namer` (use `LinkSet::namer=` and `LinkSet::namer`)
+* Removed the `SitemapGenerator::SitemapNamer` class (use `SitemapGenerator::SimpleNamer`)
+* Removed `LinkSet::add_links()` (use `LinkSet::create()`)
+
+### Version 4.0.0
+
+Version 4.0 introduces a new **non-backwards compatible** naming scheme.  **If you are running version 3 or earlier and you upgrade to version 4, you need to make a couple small changes to ensure that search engines can still find your sitemaps!**  Your sitemaps will still work fine, but the name of the index file has changed.
+
+#### So what has changed?
+
+* **The index is generated intelligently**.  SitemapGenerator now detects whether you need an index or not, and only generates one if you need it or have requested it.  So small sites (less than 50,000 links) won't have one, large sites will.  You don't have to worry about anything.  And with the `create_index` option, it's easier than ever to control index creation to suit your needs.
+
+* **The default index file name has changed** from `sitemap_index.xml.gz` to just `sitemap.xml.gz`.  So the `_index` part has been removed.  This is a more standard naming scheme for the sitemaps. Any further sitemaps are named `sitemap1.xml.gz`, `sitemap2.xml.gz`, `sitemap3.xml.gz` etc, just as before.
+
+* **Everyone now points search engines to the `sitemap.xml.gz` file**.  It doesn't matter whether your site has 10 links or a million links, just point to `sitemap.xml.gz`.  If your site needs an index, that is the index.  If it doesn't, then that's your sitemap.  Simple.
+
+* **It's easier to write custom namers** because the index and the sitemaps share the same namer instance (which is now a `SitemapGenerator::SimpleNamer` instance).
+
+* **Groups share the new naming convention**.  So the files in your `geo` group will be named `geo.xml.gz`, `geo1.xml.gz`, `geo2.xml.gz` etc.  Pre-version 4 these files would have been named `geo1.xml.gz`, `geo2.xml.gz`, `geo3.xml.gz` etc.
+
+#### I don't want it!  How can I keep everything as it was?
+
+You don't care, you just want to get on with your day.  To resort to pre-version 4 behaviour add the following to your sitemap config:
+
+```ruby
+SitemapGenerator::Sitemap.create_index = true
+SitemapGenerator::Sitemap.namer = SitemapGenerator::SimpleNamer.new(:sitemap, :zero => '_index')
+```
+
+This tells SitemapGenerator to always create an index file and to name it `sitemap_index.xml.gz`.  If you are already using custom namers, you don't need to set `namer`; your old namers should still work as before.  If you are using named groups, setting the sitemap namer in this way won't affect your groups, which will still be using the new naming scheme.  If this is an issue for you, you may have to create namers for your groups.
+
+#### I want it!  What do I need to do?
+
+1. Update your `robots.txt` file and make sure it points to `sitemap.xml.gz`.
+2. Generate your sitemaps to create the new `sitemap.xml.gz` file.
+3. Optionally remove the old `sitemap_index.xml.gz` file (or link it to the new file if you want to make sure that search engines can find it while you update them.)
+4. Go to your Google Webmaster tools and other places where you've pointed search engines to your sitemaps and point them to your new `sitemap.xml.gz` file.
 
+That's it!  Welcome to the future!
 
 ## Thanks (in no particular order)
 
@@ -1145,13 +1178,11 @@ Copyright (c) 2009 Karl Varga released under the MIT license
 [sitemap_images]:http://www.google.com/support/webmasters/bin/answer.py?answer=178636
 [sitemap_video]:https://support.google.com/webmasters/answer/80471?hl=en&ref_topic=4581190
 [sitemap_news]:https://support.google.com/news/publisher/topic/2527688?hl=en&ref_topic=4359874
-[sitemap_geo]:#
 [sitemap_mobile]:http://support.google.com/webmasters/bin/answer.py?hl=en&answer=34648
 [sitemap_pagemap]:https://developers.google.com/custom-search/docs/structured_data#addtositemap
 [sitemap_protocol]:http://www.sitemaps.org/protocol.html
 [video_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=80472#4
 [image_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=178636
-[geo_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=94555
 [news_tags]:http://www.google.com/support/news_pub/bin/answer.py?answer=74288
 [remote_hosts]:https://github.com/kjvarga/sitemap_generator/wiki/Generate-Sitemaps-on-read-only-filesystems-like-Heroku
 [include_index_change]:https://github.com/kjvarga/sitemap_generator/issues/70