Merge pull request #267 from DefangLabs/linda-misc-readme

Miscellaneous readme updates

Author: jordanstephens

README.md

@@ -2,36 +2,56 @@
 
 [![1-click-deploy](https://defang.io/deploy-with-defang.png)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-angular-express-template%26template_owner%3DDefangSamples)
 
-This project demonstrates both client-side component rendering and hydration with Angular, as well as server-side rendering with Node.js and Socket.IO for real-time communication. It also includes Docker configurations for easy deployment.
+This sample demonstrates how to deploy a full-stack Angular and Node.js application with Defang. It uses Socket.IO for real-time communication. The Docker setup ensures the app can be easily built and deployed.
 
-## NOTE
+## Prerequisites
 
-This sample showcases how you could deploy a full-stack application with Angular and Node.js using Defang. The Docker setup ensures the app can be easily built and deployed.
+1. Download [Defang CLI](https://github.com/DefangLabs/defang)
+2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
+3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
+4. Install [Node.js](https://nodejs.org/en/download/package-manager/)
+5. Install [Angular CLI](https://angular.io/cli)
 
-## Essential Setup Files
+## Development
+For development, we use two local containers, one for the frontend Angular service and one for the backend service in Express. It also uses Caddy as a web server for serving static files. 
 
-1. Download [Defang CLI](https://github.com/defang-io/defang)
-2. (Optional) If you are using [Defang BYOC](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) authenticated with your AWS account
-3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
+To run the application locally, you can use the following command:
 
-## Prerequisites
+```bash
+docker compose -f compose.dev.yaml up --build
+```
 
-1. Download [Defang CLI](https://github.com/defang-io/defang)
-2. (Optional) If you are using [Defang BYOC](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) make sure you have properly authenticated your AWS account
-3. [Node.js](https://nodejs.org/en/download/package-manager/)
-4. [Angular CLI](https://angular.io/cli)
+## Configuration
 
-## A Step-by-Step Guide for deployment
+For this sample, you will not need to provide [configuration](https://docs.defang.io/docs/concepts/configuration). 
 
-1. Open the terminal and type `defang login`
-2. Type `defang compose up` in the CLI
-3. Your app should be up and running with Defang in minutes!
+If you wish to provide configuration, see below for an example of setting a configuration for a value named `API_KEY`.
 
-## Development
+```bash
+defang config set API_KEY
+```
+
+## Deployment
+
+> [!NOTE]
+> Download [Defang CLI](https://github.com/DefangLabs/defang)
+
+### Defang Playground
+
+Deploy your application to the Defang Playground by opening up your terminal and typing:
+```bash
+defang compose up
+```
+
+### BYOC (AWS)
 
-For development, we use two local containers, one for the frontend Angular service and one for the backend service in Express. It also uses Caddy as a web server for serving static files. To run the sample locally after cloning the repository, you can run on Docker by doing:
+If you want to deploy to your own cloud account, you can use Defang BYOC:
 
-1. `docker compose -f compose.dev.yaml up --build`
+1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and check that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
+2. Run in a terminal that has access to your AWS environment variables:
+    ```bash
+    defang --provider=aws compose up
+    ```
 
 ---
 
@@ -41,4 +61,4 @@ Short Description: A full-stack application using Angular for the frontend and N
 
 Tags: Angular, Node.js, Socket.IO, TypeScript, JavaScript
 
-Languages: nodejs
+Languages: nodejs