README Cleanup

Author: dag-andersen

README.md

@@ -47,7 +47,7 @@ The implementation is actually quite simple. It just follows the steps below:
 - Provides a clear and concise view of the changes
 - Render resources from external sources (e.g., Helm charts). For example, when you update the chart version of Nginx, you can get a render of the new output. For example, this is useful to spot changes in default values. [PR example](https://github.com/dag-andersen/argocd-diff-preview/pull/15). 
 
-### Not supported
+#### Not supported
 - Does not support ArgoCD CMP plugins
 - Does not work [Cluster Generators](https://argocd-applicationset.readthedocs.io/en/stable/Generators-Cluster/) in your ApplicationSets
 
@@ -73,7 +73,7 @@ docker run \
 
 and the output would be something like this:
 
-```bash
+```
 ...
 🚀 Creating cluster...
 🚀 Cluster created successfully
@@ -100,12 +100,13 @@ Pre-requisites:
 docker run \
    --network host \                                   # This is required so the container can access the local cluster on the host's docker daemon.
    -v /var/run/docker.sock:/var/run/docker.sock \     # This is required to access the host's docker daemon.
-   -v <path-to-main-branch>:/base-branch \            # This is the main branch's ArgoCD applications.
+   -v <path-to-main-branch>:/base-branch \
    -v <path-to-pr-branch>:/target-branch \
    -v $(pwd)/output:/output \
-   -e base_branch=main \
-   -e target_branch=<name-of-the-target-branch> \
-   dag-andersen/argocd-diff
+   -e BASE_BRANCH=main \
+   -e TARGET_BRANCH=<name-of-the-target-branch> \
+   -e GIT_REPO="https://github.com/dag-andersen/argocd-diff-preview.git" \
+   dagandersen/argocd-diff-preview:latest
 ```
 
 <details>
@@ -170,7 +171,7 @@ cargo run -- --help
 
 ### Handling credentials
 
-In the simple code example above, I do not provide the cluster with any credentials, which only works if the image registry and the git repository are public. Since your Git repository might not be public you need to provide the tool with the necessary read-access credentials for the repository. This can be done by placing the Argo CD repo secrets in folder mounted at `/secrets`. When the tool starts, it will simply run `kubectl apply -f /secrets` to apply every resource to the cluster, before starting the rendering process.
+In the simple code examples above, we do not provide the cluster with any credentials, which only works if the image registry and the git repository are public. Since your Git repository might not be public you need to provide the tool with the necessary read-access credentials for the repository. This can be done by placing the Argo CD repo secrets in folder mounted at `/secrets`. When the tool starts, it will simply run `kubectl apply -f /secrets` to apply every resource to the cluster, before starting the rendering process.
 
 <details>
   <summary>Credentials example - Username + Password </summary>
@@ -218,7 +219,7 @@ For more info, see the [Argo CD docs](https://argo-cd.readthedocs.io/en/stable/o
 
 ### Scalability and performance
 
-Rendering the manifests generated by all applications in the repository on each pull request is slow. This can be annoying, especially if only a few applications have changed. The tool supports grepping applications with regex. Setting the environment variable `FILE_REGEX` only allows the tool to run on manifests that match a particular regex.
+Rendering the manifests generated by all applications in the repository on each pull request is slow. The tool supports grepping applications with regex. Setting the environment variable `FILE_REGEX` only allows the tool to run on manifests that match a particular regex. 
 
 For example, If someone in your organization from Team A changes to one of their applications, the tool can be run with `FILE_REGEX=/Team-A/` so it only renders changes in folders matching `*/Team-A/*`. This speeds up the process significantly.
 
@@ -249,6 +250,7 @@ OPTIONS:
 ## Roadmap
 - Make a dedicated GitHub Action that wraps the Docker container, so the tool becomes more user-friendly.  
 - Let the user specify Argo CD version. Currently it always uses the newest version available.
+- Let the user specify how many lines above and below the diff they want to see. This is useful when the diff is too big to be displayed in a PR comment.
 - Delete Argo CD Applications, when they have been parsed by the tool, so Argo CD can focus on the remaining applications, which hopefully speeds up the process. 
 
 ## Do you experience any issues?