Merge pull request #13 from cloud-on-prem/readme-fixes

Add Changelog and fix README

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog],
+and this project adheres to [Semantic Versioning].
+
+## [0.1.0] - 2023-03-23
+
+- initial release
+
+<!-- Links -->
+[keep a changelog]: https://keepachangelog.com/en/1.0.0/
+[semantic versioning]: https://semver.org/spec/v2.0.0.html
+
+<!-- Versions -->
+[0.1.0]: https://github.com/cloud-on-prem/iam-capable/releases/tag/v0.1.0

README.md

@@ -18,22 +18,22 @@ This tool retrieves the policies attached to one or multiple AWS IAM roles and d
 
 1. Ensure the shell is configured to use AWS Credentials. Follow the [instructions here](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html) to set it up.
 
-2. Fetch the capabilities of a single IAM role:
-
-  ```sh
-    iam-capable fetch --role ROLE_NAME [--output-format OUTPUT_FORMAT]
-    # - ROLE_NAME: The name of the IAM role to fetch capabilities for.
-    # - OUTPUT_FORMAT (optional): The output format for the fetched results. Available formats: CSV (default), JSON.
-  ```
+2. Fetch the capabilities of a single IAM role:  
+  
+    ```sh
+      iam-capable fetch --role ROLE_NAME [--output-format OUTPUT_FORMAT]
+      # - ROLE_NAME: The name of the IAM role to fetch capabilities for.
+      # - OUTPUT_FORMAT (optional): The output format for the fetched results. Available formats: CSV (default), JSON.
+    ```  
 
 3. Compare the capabilities of two IAM roles:
 
-  ```sh
-    iam-capable compare --role1 ROLE_NAME1 --role2 ROLE_NAME2 [--output-format OUTPUT_FORMAT]
-    # - ROLE_NAME1: The name of the first IAM role to compare capabilities for.
-    # - ROLE_NAME2: The name of the second IAM role to compare capabilities for.
-    # - OUTPUT_FORMAT (optional): The output format for the fetched results. Available formats: CSV (default), JSON.
-  ```
+    ```sh
+      iam-capable compare --role1 ROLE_NAME1 --role2 ROLE_NAME2 [--output-format OUTPUT_FORMAT]
+      # - ROLE_NAME1: The name of the first IAM role to compare capabilities for.
+      # - ROLE_NAME2: The name of the second IAM role to compare capabilities for.
+      # - OUTPUT_FORMAT (optional): The output format for the fetched results. Available formats: CSV (default), JSON.
+    ```
 
 ## Sample Outputs (when piped to [csvkit](https://csvkit.readthedocs.io/en/latest/) or [jq](https://github.com/stedolan/jq))
 
@@ -67,7 +67,6 @@ $ iam-capable fetch --role myrole1 --output_format json | jq .
 4. Build the project: `cargo build --release`
 5. The binary will be available at `./target/release/iam-capable`
 
-
 ---
 
 ## License