summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README14
1 files changed, 14 insertions, 0 deletions
diff --git a/README b/README
index 6c8dd36..a09513a 100644
--- a/README
+++ b/README
@@ -40,6 +40,20 @@ time. Use `make -j2` to fetch English and Chinese metadata in parallel:
CONCURRENCY=8 make -j2
+RELEASE
+-------
+After building the artifacts, you may want to share them with other projects
+so they can reference the latest API changes. This repository publishes
+artifacts to Cloudflare R2. Specify the bucket name with the `R2_BUCKET`
+environment variable. Tarballs and their associated signatures are then
+uploaded to that bucket.
+
+Make sure npm is available, because uploads are handled by the Wrangler CLI
+under the hood. For example:
+
+ R2_BUCKET=<your-bucket-name> make release
+
+
AUTHOR
------
Zhineng Li <[email protected]>