From fdfa4243b979d6606e12b1dab141b62ffa8a750b Mon Sep 17 00:00:00 2001
From: Dewan Ishtiaque Ahmed <30604461+dewan-ahmed@users.noreply.github.com>
Date: Fri, 4 Jun 2021 11:20:46 -0300
Subject: [PATCH 1/2] Removing preceding '$' from code blocks

When a user tries to copy a code block using the "copy" button, the preceding '$' gets copied too and defeats the purpose of the shortcut button. Hence proposing the removal of the preceding '$' from code blocks.
---
 README.md | 32 +++++++++++++++++++-------------
 1 file changed, 19 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 19c58069a9..c0eb3fbc04 100644
--- a/README.md
+++ b/README.md
@@ -36,37 +36,37 @@ Shipwright supports any tool that can build container images in Kubernetes clust
 * We also require a Tekton installation (v0.19+). To install the latest version, run:
 
   ```bash
-  $ kubectl apply --filename https://storage.googleapis.com/tekton-releases/pipeline/previous/v0.20.1/release.yaml
+  kubectl apply --filename https://storage.googleapis.com/tekton-releases/pipeline/previous/v0.20.1/release.yaml
   ```
 
 * Install the Shipwright deployment. To install the latest version, run:
 
   ```bash
-  $ kubectl apply --filename https://github.com/shipwright-io/build/releases/download/nightly/nightly-2021-03-24-1616591545.yaml
+  kubectl apply --filename https://github.com/shipwright-io/build/releases/download/nightly/nightly-2021-03-24-1616591545.yaml
   ```
 
 * Install the Shipwright strategies. To install the latest version, run:
 
   ```bash
-  $ kubectl apply --filename https://github.com/shipwright-io/build/releases/download/nightly/default_strategies.yaml
+  kubectl apply --filename https://github.com/shipwright-io/build/releases/download/nightly/default_strategies.yaml
   ```
 
 * Generate a secret to access your container registry, such as one on [Docker Hub](https://hub.docker.com/) or [Quay.io](https://quay.io/):
 
   ```bash
-  $ REGISTRY_SERVER=https://index.docker.io/v1/ REGISTRY_USER=<your_registry_user> REGISTRY_PASSWORD=<your_registry_password>
-  $ kubectl create secret docker-registry push-secret \
+  REGISTRY_SERVER=https://index.docker.io/v1/ REGISTRY_USER=<your_registry_user> REGISTRY_PASSWORD=<your_registry_password>
+  kubectl create secret docker-registry push-secret \
       --docker-server=$REGISTRY_SERVER \
       --docker-username=$REGISTRY_USER \
       --docker-password=$REGISTRY_PASSWORD  \
-      --docker-email=me@here.com
+      --docker-email=<your_email>
   ```
 
 * Create a Build object, replacing `<REGISTRY_ORG>` with the registry username your `push-secret` secret have access to:
 
   ```bash
-  $ REGISTRY_ORG=<your_registry_org>
-  $ cat <<EOF | kubectl apply -f -
+  REGISTRY_ORG=<your_registry_org>
+  cat <<EOF | kubectl apply -f -
   apiVersion: shipwright.io/v1alpha1
   kind: Build
   metadata:
@@ -86,15 +86,18 @@ Shipwright supports any tool that can build container images in Kubernetes clust
   ```
 
   ```bash
-  $ kubectl get builds
-  NAME                     REGISTERED   REASON      BUILDSTRATEGYKIND      BUILDSTRATEGYNAME   CREATIONTIME
-  buildpack-nodejs-build   True         Succeeded   ClusterBuildStrategy   buildpacks-v3       68s
+  kubectl get builds
   ```
+The output will be something like:
 
+  ```
+  NAME                     REGISTERED   REASON      BUILDSTRATEGYKIND      BUILDSTRATEGYNAME   CREATIONTIME
+  buildpack-nodejs-build   True         Succeeded   ClusterBuildStrategy   buildpacks-v3       68s
+  ```  
 * Submit your buildrun:
 
   ```bash
-  $ cat <<EOF | kubectl create -f -
+  cat <<EOF | kubectl create -f -
   apiVersion: shipwright.io/v1alpha1
   kind: BuildRun
   metadata:
@@ -108,7 +111,10 @@ Shipwright supports any tool that can build container images in Kubernetes clust
 * Wait until your buildrun is completed:
 
   ```bash
-  $ kubectl get buildruns
+  kubectl get buildruns
+  ```
+
+  ```
   NAME                              SUCCEEDED   REASON      STARTTIME   COMPLETIONTIME
   buildpack-nodejs-buildrun-xyzds   True        Succeeded   69s         2s
   ```

From 48836ab4554933d15c143171090c744482a9cd64 Mon Sep 17 00:00:00 2001
From: Dewan Ishtiaque Ahmed <30604461+dewan-ahmed@users.noreply.github.com>
Date: Mon, 7 Jun 2021 12:42:15 -0300
Subject: [PATCH 2/2] Updating based on review comments

- Put '$' back to command outputs
- Replaced build with *Build* and buildruns with *BuildRuns* since those are names of CRDs.
---
 README.md | 23 ++++++++++-------------
 1 file changed, 10 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index c0eb3fbc04..9d05ec1c07 100644
--- a/README.md
+++ b/README.md
@@ -62,7 +62,7 @@ Shipwright supports any tool that can build container images in Kubernetes clust
       --docker-email=<your_email>
   ```
 
-* Create a Build object, replacing `<REGISTRY_ORG>` with the registry username your `push-secret` secret have access to:
+* Create a *Build* object, replacing `<REGISTRY_ORG>` with the registry username your `push-secret` secret have access to:
 
   ```bash
   REGISTRY_ORG=<your_registry_org>
@@ -85,16 +85,15 @@ Shipwright supports any tool that can build container images in Kubernetes clust
   EOF
   ```
 
-  ```bash
-  kubectl get builds
-  ```
-The output will be something like:
+To view the *Build* which you just created:
 
   ```
+ $ kubectl get builds
+ 
   NAME                     REGISTERED   REASON      BUILDSTRATEGYKIND      BUILDSTRATEGYNAME   CREATIONTIME
   buildpack-nodejs-build   True         Succeeded   ClusterBuildStrategy   buildpacks-v3       68s
   ```  
-* Submit your buildrun:
+* Submit your *BuildRun*:
 
   ```bash
   cat <<EOF | kubectl create -f -
@@ -108,13 +107,11 @@ The output will be something like:
   EOF
   ```
 
-* Wait until your buildrun is completed:
-
-  ```bash
-  kubectl get buildruns
-  ```
+* Wait until your *BuildRun* is completed and then you can view it as follows:
 
   ```
+  $ kubectl get buildruns
+  
   NAME                              SUCCEEDED   REASON      STARTTIME   COMPLETIONTIME
   buildpack-nodejs-buildrun-xyzds   True        Succeeded   69s         2s
   ```
@@ -122,10 +119,10 @@ The output will be something like:
   or
 
   ```bash
-  $ kubectl get buildrun --output name | xargs kubectl wait --for=condition=Succeeded --timeout=180s
+  kubectl get buildrun --output name | xargs kubectl wait --for=condition=Succeeded --timeout=180s
   ```
 
-* After your buildrun is completed, check your container registry, you will find the new generated image uploaded there.
+* After your *BuildRun* is completed, check your container registry, you will find the new generated image uploaded there.
 
 ## Please tell us more!