diff --git a/yarn-project/builder/README.md b/yarn-project/builder/README.md index 3b2a17296766..d584eb774476 100644 --- a/yarn-project/builder/README.md +++ b/yarn-project/builder/README.md @@ -1,12 +1,11 @@ -# Aztec.nr compiler +# Aztec builder -The Aztec.nr compiler compiles Aztec.nr contracts using nargo and outputs Aztec formatted contract ABIs. -The compiler can also generate typescript classes for each contract, as well as Aztec.nr interfaces for calling external functions. +The Aztec builder generates typescript classes for Noir contract, as well as Aztec.nr interfaces for calling external functions. It can also be used to update aztec project dependencies. ## Installation -To install the package, run: +To install the package, run: ```bash yarn add @aztec/builder @@ -14,15 +13,8 @@ yarn add @aztec/builder ## Usage -To run the compiler as a CLI tool, first install the package and then run: +To run the tool, first install the package and then run: ```bash -yarn aztec-builder compile --help +yarn aztec-builder --help ``` - -You can also run the compiler from the [main Aztec CLI](../cli/README.md), which includes several other features for interacting with the Aztec Network: - -```bash -yarn add @aztec/cli -yarn aztec-cli compile --help -``` \ No newline at end of file