1 files changed, 13 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..90e8eca
--- /dev/null
+++ b/README
@@ -0,0 +1,13 @@
+This package provides Alibaba Cloud API metadata as PHP array files,
+generated from the original JSON metadata.
+
+The documentation and examples have been stripped to optimize for SDK
+generation and faster I/O loading. If you require the full version of
+the metadata, please refer to the `acs-metadata-full` repository.
+
+The PHP array files are pre-generated from the `acs-metadata-build`
+repository, and the artifacts are hosted on Cloudflare R2. To update
+metadata, set the bucket name in the `R2_BUCKET` environment variable and
+specify the release tag with `TAG`, then run the Makefile target:
+
+    R2_BUCKET=<your-bucket-name> TAG=<version> make deploy