Add info into the readme.

otarsko · Mar 13, 2017 · 578630d · 578630d
1 parent 277d6ed
commit 578630d
Show file tree

Hide file tree

Showing 10 changed files with 71 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,74 @@
-# aem-seo-canonical-url
-
 [![Build Status](https://travis-ci.org/otarsko/aem-seo-canonical-url.svg?branch=master)](https://travis-ci.org/otarsko/aem-seo-canonical-url)
 [![Coverage Status](https://coveralls.io/repos/github/otarsko/aem-seo-canonical-url/badge.svg?branch=master)](https://coveralls.io/github/otarsko/aem-seo-canonical-url?branch=master)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+# Canonical Tagging Support for AEM
+This is a library for inserting canonical tags into you pages.
+
+## Why
+Many sites requires content duplication. For example, there can be a sub-tree for each department in the company,
+where they have their content. However, they may have content which is equal to content in the corporate section.
+
+At the same time, content duplication can greatly affect your ranking.
+Unfortunately, AEM does not provide flexible way of handling this.
+
+## What
+This library provides next features:
+
+* strict mapping, e.g. /path/page1 --(has canonical page)--> /anotherPath/page1
+* mapping by the pattern with lookup path, e.g. /path/page[0-9] --(all pages under path have canonical pages)--> /anotherPath
+
+## How
+To build and install bundle to your AEM instance, use next command (host/port values should be adjusted to the values you have):
+
+`mvn clean install -PautoInstallBundle -Daem.host=localhost -Daem.port=4502`
+
+After bundle installed, next steps should be performed:
+
+1. [Create system user](http://www.aemcq5tutorials.com/tutorials/create-system-user-in-aem/), grant required permissions to it and configure it for the bundle *com.taradevko.aem.seo*:
+
+ ![Grant user permissions](doc/aem-grant-permisions.png)
+
+ ![User mapping](doc/aem-user-mapping.png)
+
+1. Configure service *Canonical Tagging Support* (pid com.taradevko.aem.seo.service.CanonicalTaggingImpl). Via Web Console/sling:OsgiConfig:
+
+ ![AEM Canonical Configuration](doc/aem-canonical-configuration.png)
+
+ Rule has next syntax:
+
+ * for **strict** rules, where page is mapped to another page: `_PATH PAGE 1_=>_CANONICAL PAGE PATH_`
+ * for rules which map pages by regex and provide lookup path: `_PATTERN FOR PAGE WHICH CHILD WILL BE MAPPED_>_LOOKUP PATH_`
+
+1. Add canonical tag to your <head></head>. To do this: insert next code into the required place:
+    ```
+          <link
+              data-sly-use.canonicalTagging="com.taradevko.aem.seo.CanonicalLinkModel"
+              data-sly-test="${canonicalTagging.hasCanonicalPage}"
+              rel="canonical"
+              href="${canonicalTagging.canonicalUrl}.html" />
+    ```
+1. Make sure, that externalizer is configured. Also, you can additionally configure URL Mappings in Resource Resolver Factory, to omit some part of the path in URL.
+
+ ![AEM Externalizer Configuration](doc/aem-externalizer-config.png)
+
+ ![AEM Resource Resolver mapping](doc/aem-resource-resolver-mapping.png)
+
+## Examples
+Page structure:
+
+ ![AEM SEO Example structue](doc/aem-seo-structure.png)
+
+Having configuration and structure, how it is shown above, we will get next results:
+
+* strict rule
+
+ ![AEM SEO Canonical Strict rule](doc/aem-canonical-example-strict.png)
+
+* pattern rule
+
+ ![AEM SEO Canonical Pattern rule](doc/aem-canonical-example-pattern.png)
+
+* pattern rule with url mapping
 
-Canonical URL for AEM page
+ ![AEM SEO Canonical Pattern rule with url mapping](doc/aem-canonical-example-pattern-with-url-mapping.png)
diff --git a/doc/aem-canonical-configuration.png b/doc/aem-canonical-configuration.png
diff --git a/doc/aem-canonical-example-pattern-with-url-mapping.png b/doc/aem-canonical-example-pattern-with-url-mapping.png
diff --git a/doc/aem-canonical-example-pattern.png b/doc/aem-canonical-example-pattern.png
diff --git a/doc/aem-canonical-example-strict.png b/doc/aem-canonical-example-strict.png
diff --git a/doc/aem-externalizer-config.png b/doc/aem-externalizer-config.png
diff --git a/doc/aem-grant-permisions.png b/doc/aem-grant-permisions.png
diff --git a/doc/aem-resource-resolver-mapping.png b/doc/aem-resource-resolver-mapping.png
diff --git a/doc/aem-seo-structure.png b/doc/aem-seo-structure.png
diff --git a/doc/aem-user-mapping.png b/doc/aem-user-mapping.png