From 11035f97bcefd299f1aa8740e1ed7e4f1c3c3c70 Mon Sep 17 00:00:00 2001
From: Arne Setzer <25772747+arnesetzer@users.noreply.github.com>
Date: Fri, 6 Sep 2024 14:15:33 +0200
Subject: [PATCH] docs: Add entry for oa token (#520)

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 95eac88bc..e3584305b 100644
--- a/README.md
+++ b/README.md
@@ -161,6 +161,13 @@ This is useful, for example, when downloading from `s3://data.openaddresses.io`,
 as they require the requester to pay for data transfer.
 You can then use the following option: `--request-payer`
 
+### `imports.openaddresses.token`
+* Required: no
+* Default: Shared token for the pelias project
+
+Since openaddresses moved from [results.openaddresses.io](https://results.openaddresses.io) to [batch.openaddresses.org](https://batch.openaddresses.org), you need a token to access the data. There is a default shared token for the Pelias project, but if you want to use it seriously, create your own account and token on [batch.openaddresses.org. ](https://batch.openaddresses.org) to avoid possible throttling/bandwidth limit or (temporary) suspension.
+
+
 ## Parallel Importing
 
 Because OpenAddresses consists of many small files, this importer can be configured to run several instances in parallel that coordinate to import all the data.