diff --git a/README.md b/README.md index 4054544..b540858 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,22 @@ For important context, check out [DESIGN.md](./DESIGN.md), along with designs in ## Usage -See the [podcast example BUILD file](examples/podcast_reviews/BUILD.bazel). +### Graph Description Methods + +- **Bazel targets**: The foundational +- **Python DSL**: A more succinct method with partition patterns and decorator-based auto graph wiring. [Example usage.](databuild/test/app/dsl/graph.py) + +### Examples +- Test app: [color votes](databuild/test/app/README.md) + - [Bazel graph description example](databuild/test/app/bazel/BUILD.bazel) + - [Python DSL description example](databuild/test/app/dsl/graph.py) +- See the [podcast example BUILD file](examples/podcast_reviews/BUILD.bazel). + +### Ways to Use DataBuild in Production + +- **As a CLI build tool**: You can run DataBuild builds from the command line or in a remote environment - no build event log required! +- **As a standalone service**: Similar to Dagster or Airflow, you can run a persistent service that you send build requests to, and which serves an API and web dashboard. +- **As a cloud-native containerized build tool**: Build containers from your graphs and launch scheduled builds using a container service like ECS, or even your own kubernetes cluster. ## Development