Update the README and direnv configuration

facebook · Oct 29, 2024 · d9c7b9b · d9c7b9b
1 parent 64339ba
commit d9c7b9b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/examples/persistent_worker/.envrc b/examples/persistent_worker/.envrc
@@ -0,0 +1,3 @@
+# specify the following:
+# - BUILDBUDDY_API_KEY
+source_env_if_exists .envrc.private
diff --git a/examples/persistent_worker/README.md b/examples/persistent_worker/README.md
@@ -10,24 +10,21 @@ support for remote persistent workers to Buck2, see [#776].
 
 ## Requirements
 
-The demo uses Nix to provide required system dependencies, such as
-Python and grpc-io. As well as direnv to set up the environment.
+This demo uses BuildBuddy remote execution to demonstrate remote
+persistent workers. You will need an API token for at least a free open
+source account. You can use [direnv] to set up the environment:
 
-- [Nix](https://nixos.org/)
-- [direnv](https://direnv.net/)
-
-Credentials for [BuildBuddy](https://www.buildbuddy.io/) and
-[GHCR](https://ghcr.io) stored in `.envrc.private`:
+Credentials for [BuildBuddy] stored in `.envrc.private`:
 ```
 export BUILDBUDDY_API_KEY=...
-export BUILDBUDDY_CONTAINER_USER=...  # GitHub user name
-export BUILDBUDDY_CONTAINER_PASSWORD=...  # GitHub access token
-export GITHUB_USER=... # GitHub user name
 ```
 
 Upload the Nix Docker image for remote execution as described in
 `platforms/buildbuddy.bzl`.
 
+[direnv]: https://direnv.net/
+[BuildBuddy]: https://www.buildbuddy.io/
+
 ## Local Build
 
 Configure a local build without persistent workers: