Merge pull request #29 from CloudNativeAI/feature/readme

chore: add ci badge and godoc badge for README.md
Signed-off-by: Gaius <[email protected]>

.github/workflows/codeql-analysis.yml

@@ -1,14 +1,14 @@
 name: CodeQL Analysis
 
-# on:
-  # push:
-    # branches: [main, release-*]
-    # paths-ignore: ['**.md', '**.png', '**.jpg', '**.svg', '**/docs/**']
-  # pull_request:
-    # branches: [main, release-*]
-    # paths-ignore: ['**.md', '**.png', '**.jpg', '**.svg', '**/docs/**']
-  # schedule:
-    # - cron: '0 4 * * *'
+on:
+  push:
+    branches: [main, release-*]
+    paths-ignore: ['**.md', '**.png', '**.jpg', '**.svg', '**/docs/**']
+  pull_request:
+    branches: [main, release-*]
+    paths-ignore: ['**.md', '**.png', '**.jpg', '**.svg', '**/docs/**']
+  schedule:
+    - cron: '0 4 * * *'
 
 permissions:  
   contents: read

README.md

@@ -1,7 +1,7 @@
 # modctl
 
-[![GitHub release](https://img.shields.io/github/release/CloudNativeAI/modctl.svg)](https://github.com/CloudNativeAI/modctl/releases)
-[![LICENSE](https://img.shields.io/github/license/CloudNativeAI/modctl.svg?style=flat-square)](https://github.com/CloudNativeAI/modctl/blob/main/LICENSE)
+[![CI](https://github.com/CloudNativeAI/modctl/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/CloudNativeAI/modctl/actions/workflows/ci.yml)
+[![GoDoc](https://godoc.org/github.com/CloudNativeAI/modctl?status.svg)](https://godoc.org/github.com/CloudNativeAI/modctl)
 
 Modctl is a user-friendly CLI tool for managing OCI model artifacts, which are bundled based on [Model Spec](https://github.com/CloudNativeAI/model-spec).
 It offers commands such as `build`, `pull`, `push`, and more, making it easy for users to convert their AI models into OCI artifacts.
@@ -12,4 +12,4 @@ You can find the full documentation on the [getting started](./docs/getting-star
 
 ## LICENSE
 
-Apache 2.0 License. Please see [LICENSE](LICENSE) for more information.
+Apache 2.0 License. Please see [LICENSE](LICENSE) for more information.