Merge pull request #11 from kishaningithub/documentation-update

Update documentation
kishaningithub · Feb 23, 2024 · fa51315 · fa51315
2 parents 9c639f8 + e8f7f09
commit fa51315
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 8 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,8 +7,8 @@
   installed.
 - To format the code, run command `make fmt`.
 - To build the project, run command `make build`.
-- To run the test suite, run command `make test`.
+- To run only the tests, run command `make test`.
 
 ## Upgrading dependencies
 - For code, run command `make update-deps`
-- For actions, go inside the yamls present in the [workflows](.github/workflows/) and bump the versions.
+- For actions, go inside the yamls present in the [workflows](.github/workflows/) and bump the versions.
diff --git a/README.md b/README.md
@@ -30,14 +30,10 @@ brew install kishaningithub/tap/tf-import-gen
 
 ### Using docker
 
-Pulling the image
 ```bash
-docker pull ghcr.io/kishaningithub/tf-import-gen:0.1.0
-```
+alias tf-import-gen="docker run -i ghcr.io/kishaningithub/tf-import-gen:latest"
 
-Running the image in interactive mode
-```bash
-docker run -it ghcr.io/kishaningithub/tf-import-gen:0.1.0
+terraform show -json | tf-import-gen
 ```
 
 ### Others