update readme (#4)

Arnab-Developer · Mar 19, 2021 · c13bff6 · c13bff6
1 parent d7c6b8d
commit c13bff6
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/GitHubEnvDemo.Web/Views/Shared/_Layout.cshtml b/GitHubEnvDemo.Web/Views/Shared/_Layout.cshtml
@@ -3,15 +3,15 @@
 <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>@ViewData["Title"] - GitHub env demo</title>
+    <title>@ViewData["Title"] - GitHub environment demo</title>
     <link rel="stylesheet" href="~/lib/bootstrap/dist/css/bootstrap.min.css" />
     <link rel="stylesheet" href="~/css/site.css" />
 </head>
 <body>
     <header>
         <nav class="navbar navbar-expand-sm navbar-toggleable-sm navbar-light bg-white border-bottom box-shadow mb-3">
             <div class="container">
-                <a class="navbar-brand" asp-area="" asp-controller="Home" asp-action="Index">GitHub env demo</a>
+                <a class="navbar-brand" asp-area="" asp-controller="Home" asp-action="Index">GitHub environment demo</a>
                 <button class="navbar-toggler" type="button" data-toggle="collapse" data-target=".navbar-collapse" aria-controls="navbarSupportedContent"
                         aria-expanded="false" aria-label="Toggle navigation">
                     <span class="navbar-toggler-icon"></span>
@@ -37,7 +37,7 @@
 
     <footer class="border-top footer text-muted">
         <div class="container">
-            &copy; 2021 - GitHub env demo - <a asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a>
+            &copy; 2021 - GitHub environment demo - <a asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a>
         </div>
     </footer>
     <script src="~/lib/jquery/dist/jquery.min.js"></script>

diff --git a/README.md b/README.md
@@ -1 +1,16 @@
-This is a demo app to show CI CD with GitHub action and environment.
+# GitHub environment demo
+
+This is a demo app to show CI CD with GitHub action and environment.
+
+There are two environments in this repo. 
+
+- Dev
+- Prd
+
+CI CD workflow used for this app.
+
+- For pull request to `main` only build.
+- When pull request merged in `main` then build and deploy to `Dev` environment.
+- When a release has been created then deploy to `Prd` environment.
+
+Deployment to `Prd` environment needs approval.