From 7dc3753ac0cf0a375aa34dfa0253b0e5f8d38680 Mon Sep 17 00:00:00 2001
From: Sachid26 <70128087+Sachid26@users.noreply.github.com>
Date: Wed, 24 Mar 2021 17:48:56 +0530
Subject: [PATCH] Readme Cleaned (#1)

* Readme Cleaned

* Update README.md

whitelisted changed to allowlisted

* Update README.md

readme updates.

* Update README.md

added cleanup section

* Update README.md

Co-authored-by: Nitin Issac Joy <nijoy@microsoft.com>
---
 README.md | 62 ++++++++++++++++---------------------------------------
 1 file changed, 18 insertions(+), 44 deletions(-)

diff --git a/README.md b/README.md
index 5efee445..1528bdb7 100644
--- a/README.md
+++ b/README.md
@@ -1,57 +1,31 @@
-# Project Name
-
-(short, 1-3 sentenced, description of the project)
-
-## Features
-
-This project framework provides the following features:
-
-* Feature 1
-* Feature 2
-* ...
-
-## Getting Started
-
-### Prerequisites
-
-(ideally very short, if any)
-
-- OS
-- Library version
-- ...
+# WebApp with Cosmos DB
+ 
+ A sample webapp deployed on app service with cosmos db as database. It counts the number of visitors visiting the page and inserts the same into a sample collection in Cosmos DB.
 
 ### Installation
 
-(ideally very short)
-
-- npm install [package name]
-- mvn install
-- ...
-
-### Quickstart
-(Add steps to get up and running quickly)
+1. In your terminal window, log into Azure and set a subscription(subscription which would contain the webapp) :
 
-1. git clone [repository clone url]
-2. cd [respository name]
-3. ...
+        az login
+        az account set -s mySubscriptionName
 
+2. Clone the sample application's source repository. The sample application is a Node.js app consisting of an Azure App Service web component and a Cosmos DB database. The repo also contains a PowerShell script that deploys the sample app to your Azure subscription.
 
-## Demo
+        git clone https://github.com/Azure-Samples/nodejs-appsvc-cosmosdb-bottleneck.git
 
-A demo app is included to show how to use the project.
+3. Deploy the sample app using the PowerShell script. (Tip: macOS users can install PowerShell [here](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-macos?view=powershell-7.1))
 
-To run the demo, follow these steps:
+        cd SampleApp
+        .\deploymentscript.ps1
 
-(Add steps to start up the demo)
+4. You will be prompted to supply a unique application name and a location (default is `eastus`). A resource group for the resources would be created with the same name.
+5. Once deployment is complete, browse to the running sample application with your browser.
 
-1.
-2.
-3.
+        https://<app_name>.azurewebsites.net
+## **Clean up resources**       
 
-## Resources
+You may want to delete the resources to avoid to continue incurring charges. Use the `az group delete` command to remove the resource group and all related resources.
 
-(Any additional resources or related projects)
+        az group delete --name myResourceGroup
 
-- Link to supporting information
-- Link to similar sample
-- ...
+Similarly, you can utilize the **Delete resource group** toolbar button on the sample application's resource group to remove all the resources.