From 0a4c7dbb99aa725a800276d3ee09331ea9a5fe39 Mon Sep 17 00:00:00 2001
From: David Featherston <david.featherstone@dpc.vic.gov.au>
Date: Mon, 26 Jun 2023 08:41:18 +1000
Subject: [PATCH] docs(@dpc-sdp/nuxt-ripple): update readme

---
 packages/nuxt-ripple/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/packages/nuxt-ripple/README.md b/packages/nuxt-ripple/README.md
index fab1841ef1..118de706e2 100644
--- a/packages/nuxt-ripple/README.md
+++ b/packages/nuxt-ripple/README.md
@@ -53,3 +53,30 @@ They can also be set as uppercase environment variables starting with `NUXT_` an
 NUXT_PUBLIC_TIDE_SITE=8888
 NUXT_PUBLIC_TIDE_BASE_URL=https://develop.content.reference.sdp.vic.gov.au
 ```
+
+### Robots.txt
+
+The robots.txt file is handled automatically by `@dpc-sdp/nuxt-ripple`, but can be overridden and extended via the `nuxt.config` if needed.
+
+```js
+import { createResolver } from '@nuxt/kit'
+const { resolve } = createResolver(import.meta.url)
+
+export default defineNuxtConfig({
+  robots: {
+    configPath: resolve('./robots.config.ts')
+  }
+})
+```
+
+```js
+import rules from '@dpc-sdp/nuxt-ripple/robots'
+
+export default [
+  // optionally include, filter or map the default rules
+  ...rules,
+  
+  // add addtional rules
+  { UserAgent: 'SomeCustomBot', Disallow: '/' }
+]
+```