Update documentation

CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/) and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [1.2.0] - 2021-06-24
+### Added
+* Alternate (culture variant) URLs appear in sitemap with `hreflang`
+* Google Images Sitemap for Umbraco 8.6
+* Google News Sitemap for Umbraco 8.1
+* Custom sitemaps and routes are registerable at startup
+* `SitemapBuilderBase` for overriding specific elements of sitemaps
+
+### Changed
+* `ISitemapBuilder` takes a culture for multi-lingual content
+* Sitemaps are cached for 15 minutes
+* Default configuration is more easily extensible
+* Default property aliases are configurable
+
+### Fixed
+* Corrected `sitemap.xml` schema.org namespace
+
 ## [1.1.1] - 2020-08-17
 ### Fixed
 * Excluding content without templates from the sitemap
@@ -24,7 +41,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/) and this
 ### Added
 * Initial release of Friendly Sitemap for Umbraco 8.1
 
-[Unreleased]: https://github.com/callumbwhyte/friendly-sitemap/compare/release-1.1.1...HEAD
-[1.1.1]: https://github.com/callumbwhyte/friendly-sitemap/compare/release-1.1.0
-[1.1.0]: https://github.com/callumbwhyte/friendly-sitemap/compare/release-1.1.0
-[1.0.0]: https://github.com/callumbwhyte/friendly-sitemap/compare/release-1.0.0
+[Unreleased]: https://github.com/callumbwhyte/friendly-sitemap/compare/release-1.2.1...HEAD
+[1.2.0]: https://github.com/callumbwhyte/friendly-sitemap/compare/release-1.1.0...release-1.2.0
+[1.1.1]: https://github.com/callumbwhyte/friendly-sitemap/compare/release-1.1.0...release-1.1.1
+[1.1.0]: https://github.com/callumbwhyte/friendly-sitemap/compare/release-1.0.0...release-1.1.0
+[1.0.0]: https://github.com/callumbwhyte/friendly-sitemap/tree/release-1.0.0

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Callum Whyte
+Copyright (c) 2021 Callum Whyte
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -2,14 +2,21 @@
 
 <img src="docs/img/logo.png?raw=true" alt="Umbraco Friendly Sitemap" width="250" align="right" />
 
-[![NuGet release](https://img.shields.io/nuget/v/Our.Umbraco.FriendlySitemap.svg)](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap/)
-[![Our Umbraco project page](https://img.shields.io/badge/our-umbraco-orange.svg)](https://our.umbraco.com/projects/website-utilities/friendly-sitemap/)
+Friendly Sitemap makes adding dynamic `sitemap.xml` files to your Umbraco website easy!
 
-Friendly Sitemap makes adding a dynamic `sitemap.xml` file to your Umbraco 8 website easy!
+Friendly Sitemap creates a fully compliant XML sitemap for Google search, Google Images, or Google News, for your content with no code necessary.
+
+| Package          | NuGet            | Our Umbraco      |
+|------------------|------------------|------------------|
+| Friendly Sitemap | [![NuGet](https://img.shields.io/nuget/v/Our.Umbraco.FriendlySitemap.svg)](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap/) | [![Our Umbraco](https://img.shields.io/badge/our-umbraco-orange.svg)](https://our.umbraco.com/projects/website-utilities/friendly-sitemap/) |
+| Image Sitemap    | [![NuGet](https://img.shields.io/nuget/v/Our.Umbraco.FriendlySitemap.Images.svg)](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap.Images/) |
+| News Sitemap     | [![NuGet](https://img.shields.io/nuget/v/Our.Umbraco.FriendlySitemap.News.svg)](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap.News/) |
 
 ## Getting started
 
-This package is supported on Umbraco 8.1+.
+Friendly Sitemap and the [News Sitemap](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap.News/) are supported on Umbraco 8.1+.
+
+The [Image Sitemap](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap.Images/) requires Umbraco 8.6+.
 
 ### Installation
 
@@ -27,61 +34,19 @@ To [install from NuGet](https://www.nuget.org/packages/Our.Umbraco.FriendlySitem
 
 ## Usage
 
-Once installed, the sitemap will be visible on the URL `/sitemap.xml`, such as `https://www.yoursite.com/sitemap.xml`. The items displayed in the sitemap will be specific to the current domain.
-
-If a physical `sitemap.xml` file exists in your website, the dynamically generated sitemap will be disabled.
-
-It is possible to disable the sitemap via an app setting in `web.config` file:
+Once installed the sitemap must be enabled via an app setting in the `web.config` file:
 
 ```
-<add key="Umbraco.Sitemap.EnableSitemap" value="false" />
+<add key="Umbraco.Sitemap.Enable" value="true" />
 ```
 
-### Controlling output
-
-By default the sitemap will include all content items within the current site with a template assigned.
-
-Adding a true / false (boolean) property to any doctype with the alias `sitemapExclude` makes it possible to hide specific items from the sitemap.
+The sitemap will be visible on the URL `/sitemap.xml`, such as `https://www.yoursite.com/sitemap.xml`. If installed, the [Image Sitemap](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap.Images/) will be visible on the URL `/sitemap_images.xml` while the [News Sitemap](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap.News/) will be visible on the URL `/sitemap_news.xml`.
 
-All of the XML Sitemap v0.9 [tag definitions](https://www.sitemaps.org/protocol.html#xmlTagDefinitions) can be modified by adding properties with specific aliases to any doctype:
+All links displayed in a sitemap are specific to the current domain and culture.
 
-| Attribute  | Property alias    |
-|------------|-------------------|
-| url        | url               |
-| lastmod    | updateDate        |
-| changefreq | sitemapChangeFreq | 
-| priority   | sitemapPriority   |
-
-### Advanced configuration
-
-It is possible to override the default configuration of the package using dependency injection, by registering a new instance of `SitemapConfiguration` within an `IUserComposer` class.
-
-This is helpful for advanced configuration needs, such as defining unique settings per site in a multi-site Umbraco installation.
-
-Here's an example:
+If a physical `sitemap.xml` file exists in your website, the dynamically generated sitemap will be disabled.
 
-```
-using Our.Umbraco.FriendlySitemap.Startup;
-
-[ComposeAfter(typeof(SitemapComposer))]
-public class CustomSitemapComposer : IUserComposer
-{
-    public void Compose(Composition composition)
-    {
-        composition.Register(factory => GetConfiguration(), Lifetime.Request);
-    }
-
-    private SitemapConfiguration GetConfiguration()
-    {
-        var configuration = new SitemapConfiguration
-        {
-            EnableSitemap = true
-        };
-
-        return configuration;
-    }
-}
-```
+The [project wiki](https://github.com/callumbwhyte/friendly-sitemap/wiki) contains further details about the advanced configuration options available, including creating custom sitemaps.
 
 ## Contribution guidelines
 
@@ -95,9 +60,9 @@ This project is maintained by [Callum Whyte](https://callumwhyte.com/) and contr
 
 The Friendly Sitemap logo uses the [Sitemap](https://thenounproject.com/term/sitemap/2711731/) icon from the [Noun Project](https://thenounproject.com) by [Adrien Coquet](https://thenounproject.com/coquet_adrien/), licensed under [CC BY 3.0 US](https://creativecommons.org/licenses/by/3.0/us/).
 
-The Image Sitemap logo uses the [Images](https://thenounproject.com/term/images/225394/) icon from the [Noun Project](https://thenounproject.com) by [Javi Ayala](https://thenounproject.com/javi_al/), licensed under [CC BY 3.0 US](https://creativecommons.org/licenses/by/3.0/us/).
+The [Image Sitemap](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap.Images/) logo uses the [Images](https://thenounproject.com/term/images/225394/) icon from the [Noun Project](https://thenounproject.com) by [Javi Ayala](https://thenounproject.com/javi_al/), licensed under [CC BY 3.0 US](https://creativecommons.org/licenses/by/3.0/us/).
 
-The News Sitemap logo uses the [News](https://thenounproject.com/term/news/1901962/) icon from the [Noun Project](https://thenounproject.com) by [Shashank Singh](https://thenounproject.com/rshashank19/), licensed under [CC BY 3.0 US](https://creativecommons.org/licenses/by/3.0/us/).
+The [News Sitemap](https://www.nuget.org/packages/Our.Umbraco.FriendlySitemap.News/) logo uses the [News](https://thenounproject.com/term/news/1901962/) icon from the [Noun Project](https://thenounproject.com) by [Shashank Singh](https://thenounproject.com/rshashank19/), licensed under [CC BY 3.0 US](https://creativecommons.org/licenses/by/3.0/us/).
 
 ### A special #h5yr to our contributors
 
@@ -109,6 +74,6 @@ The News Sitemap logo uses the [News](https://thenounproject.com/term/news/19019
 
 ## License
 
-Copyright &copy; 2019 [Callum Whyte](https://callumwhyte.com/), and other contributors
+Copyright &copy; 2021 [Callum Whyte](https://callumwhyte.com/), and other contributors
 
-Licensed under the [MIT License](LICENSE.md).
+Licensed under the [MIT License](LICENSE.md).

src/Our.Umbraco.FriendlySitemap.Images/Our.Umbraco.FriendlySitemap.Images.csproj

@@ -3,7 +3,7 @@
     <TargetFramework>net472</TargetFramework>
     <Version Condition="'$(BUILD_BUILDNUMBER)' == ''">1.0.0.0</Version>
     <Version Condition="'$(BUILD_BUILDNUMBER)' != ''">$(BUILD_BUILDNUMBER)</Version>
-    <Description>A friendly tool for creating dynamic Google Images sitemap.xml files in Umbraco 8</Description>
+    <Description>A friendly tool for creating dynamic Google Images sitemaps in Umbraco</Description>
     <Authors>Callum Whyte</Authors>
     <Copyright>Copyright © 2021 Callum Whyte, and other contributors</Copyright>
     <PackageLicenseUrl>https://github.com/callumbwhyte/friendly-sitemap/blob/main/LICENSE.md</PackageLicenseUrl>

src/Our.Umbraco.FriendlySitemap.News/Our.Umbraco.FriendlySitemap.News.csproj

@@ -3,7 +3,7 @@
     <TargetFramework>net472</TargetFramework>
     <Version Condition="'$(BUILD_BUILDNUMBER)' == ''">1.0.0.0</Version>
     <Version Condition="'$(BUILD_BUILDNUMBER)' != ''">$(BUILD_BUILDNUMBER)</Version>
-    <Description>A friendly tool for creating dynamic Google News sitemap.xml files in Umbraco 8</Description>
+    <Description>A friendly tool for creating dynamic Google News sitemaps in Umbraco</Description>
     <Authors>Callum Whyte</Authors>
     <Copyright>Copyright © 2021 Callum Whyte, and other contributors</Copyright>
     <PackageLicenseUrl>https://github.com/callumbwhyte/friendly-sitemap/blob/main/LICENSE.md</PackageLicenseUrl>

src/Our.Umbraco.FriendlySitemap/Our.Umbraco.FriendlySitemap.csproj

@@ -3,15 +3,15 @@
     <TargetFramework>net472</TargetFramework>
     <Version Condition="'$(BUILD_BUILDNUMBER)' == ''">1.0.0.0</Version>
     <Version Condition="'$(BUILD_BUILDNUMBER)' != ''">$(BUILD_BUILDNUMBER)</Version>
-    <Description>A friendly tool for creating dynamic sitemap.xml files in Umbraco 8</Description>
+    <Description>A friendly tool for creating dynamic sitemap.xml files in Umbraco</Description>
     <Authors>Callum Whyte</Authors>
-    <Copyright>Copyright © 2020 Callum Whyte, and other contributors</Copyright>
+    <Copyright>Copyright © 2021 Callum Whyte, and other contributors</Copyright>
     <PackageLicenseUrl>https://github.com/callumbwhyte/friendly-sitemap/blob/main/LICENSE.md</PackageLicenseUrl>
     <PackageProjectUrl>https://github.com/callumbwhyte/friendly-sitemap</PackageProjectUrl>
     <PackageIconUrl>https://raw.githubusercontent.com/callumbwhyte/friendly-sitemap/main/docs/img/logo.png</PackageIconUrl>
     <RepositoryUrl>https://github.com/callumbwhyte/friendly-sitemap</RepositoryUrl>
     <RepositoryType>Git</RepositoryType>
-    <PackageTags>umbraco xml sitemap seo</PackageTags>
+    <PackageTags>umbraco xml sitemap google seo</PackageTags>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
   </PropertyGroup>
   <ItemGroup>