Skip to content

Commit 421b808

Browse files
committed
docs: update readme
1 parent 40a5a0f commit 421b808

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
⭐ If you like this sample, star it on GitHub — it helps a lot!
1717

18-
[Overview](#overview)[Architecture](#architecture)[Getting started](#getting-started)[MCP tools](#mcp-tools)[Deploy to Azure](#deploy-to-azure)[Resources](#resources)[Troubleshooting](#troubleshooting)
18+
[Overview](#overview)[Architecture](#architecture)[Getting started](#getting-started)[Deploy to Azure](#deploy-to-azure)[Run locally](#run-locally)[MCP tools](#mcp-tools)[Resources](#resources)
1919

2020
![Animation showing the agent in action](./docs/images/demo.gif)
2121

@@ -109,9 +109,38 @@ Then you can get the project code:
109109

110110
</details>
111111

112-
### Local development
112+
## Deploy to Azure
113+
114+
### Prerequisites
115+
116+
- **Azure account**: If you're new to Azure, [get an Azure account for free](https://azure.microsoft.com/free) to get free Azure credits to get started
117+
- **Azure account permissions**: Your Azure account must have `Microsoft.Authorization/roleAssignments/write` permissions, such as [Role Based Access Control Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#role-based-access-control-administrator-preview), [User Access Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#user-access-administrator), or [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner)
118+
119+
### Deploy with Azure Developer CLI
120+
121+
1. Open a terminal and navigate to the root of the project
122+
2. Authenticate with Azure by running `azd auth login`
123+
3. Run `azd up` to deploy the application to Azure. This will provision Azure resources and deploy all services
124+
- You will be prompted to select a base location for the resources
125+
- The deployment process will take a few minutes
126+
127+
Once deployment is complete, you'll see the URLs of all deployed services in the terminal.
128+
129+
### Cost estimation
130+
131+
Pricing varies per region and usage, so it isn't possible to predict exact costs for your usage. However, you can use the Azure pricing calculator with pre-configured estimations to get an idea of the costs: [Azure Pricing Calculator](https://azure.com/e/0ddf5e6a4c654576a74b7199c85413b9).
132+
133+
### Clean up resources
134+
135+
To clean up all the Azure resources created by this sample:
136+
137+
```bash
138+
azd down --purge
139+
```
140+
141+
## Run locally
113142

114-
After setting up your environment, you can run the entire application locally:
143+
After setting up your environment and provisioned the Azure resources, you can run the entire application locally:
115144

116145
```bash
117146
# Install dependencies for all services
@@ -143,7 +172,7 @@ You can then open the Agent web app and ask things like:
143172

144173
The agent will decide which MCP tool(s) to call, then come up with a response.
145174

146-
#### Available scripts
175+
### Available scripts
147176

148177
This project uses [npm workspaces](https://docs.npmjs.com/cli/v9/using-npm/workspaces) to manage multiple packages in a single repository. You can run scripts from the root folder that will apply to all packages, or you can run scripts for individual packages as indicated in their respective README files.
149178

@@ -233,35 +262,6 @@ Then, you can use GitHub Copilot in **agent mode** to interact with the MCP serv
233262
> [!TIP]
234263
> Copilot models can behave differently regarding tools usage, so if you don't see it calling the `burger-mcp` tools, you can explicitly mention using the Bruger MCP server by adding `#burger-mcp` in your prompt.
235264
236-
## Deploy to Azure
237-
238-
### Prerequisites
239-
240-
- **Azure account**: If you're new to Azure, [get an Azure account for free](https://azure.microsoft.com/free) to get free Azure credits to get started
241-
- **Azure account permissions**: Your Azure account must have `Microsoft.Authorization/roleAssignments/write` permissions, such as [Role Based Access Control Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#role-based-access-control-administrator-preview), [User Access Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#user-access-administrator), or [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner)
242-
243-
### Deploy with Azure Developer CLI
244-
245-
1. Open a terminal and navigate to the root of the project
246-
2. Authenticate with Azure by running `azd auth login`
247-
3. Run `azd up` to deploy the application to Azure. This will provision Azure resources and deploy all services
248-
- You will be prompted to select a base location for the resources
249-
- The deployment process will take a few minutes
250-
251-
Once deployment is complete, you'll see the URLs of all deployed services in the terminal.
252-
253-
### Cost estimation
254-
255-
Pricing varies per region and usage, so it isn't possible to predict exact costs for your usage. However, you can use the Azure pricing calculator with pre-configured estimations to get an idea of the costs: [Azure Pricing Calculator](https://azure.com/e/0ddf5e6a4c654576a74b7199c85413b9).
256-
257-
### Clean up resources
258-
259-
To clean up all the Azure resources created by this sample:
260-
261-
```bash
262-
azd down --purge
263-
```
264-
265265
## Resources
266266

267267
Here are some resources to learn more about the technologies used in this project:

0 commit comments

Comments
 (0)