diff --git a/README.md b/README.md index 51f3d89..6c68145 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ # aem-seo-research Misc SEO research +## Setup +Create .env file with the following content: +``` +SPACECAT_API_KEY= +AHREFS_API_KEY= +``` +Retrieve the values from [Vault](https://vault-amer.adobe.net/ui/vault/secrets/aem_exp_success_eng/show/spacecat/seo). + ## How to trigger all assessments `npm run all ` diff --git a/assessment/README.md b/assessment/README.md index 59a702a..b62707a 100644 --- a/assessment/README.md +++ b/assessment/README.md @@ -1,9 +1,10 @@ # SEO assessment -## How to +## Setup -Run all assessments sequentially. Every assessment shall return a CSV that can be copy/pasted into the overall assessment. -Every assessment requires an URL as first parameter. The URL must be contained in SpaceCat Catalogue. +- Run all assessments sequentially. +- Every assessment shall return a CSV that can be copy/pasted into the overall assessment. +- Every assessment requires a URL as first parameter. The URL must exist within the SpaceCat Catalogue. Example: `node ./assessment/sitemap.js "https://bitdefender.com.au/solutions/"`