Merge pull request #30 from algorandfoundation/header_assets

docs: adding readme metrics badges and media kit compliant image asset

README.md

@@ -1,4 +1,23 @@
-# AlgoKit Beaker Template
+<div align="center">
+<a href="https://github.com/algorandfoundation/algokit-beaker-default-template"><img src="https://bafybeiguaon767jcuyawcee4prtzx7om6kpbe5g66zck5pgbpd5mmucamu.ipfs.nftstorage.link/" width=60%></a>
+</div>
+
+<p align="center">
+    <a target="_blank" href="https://github.com/algorandfoundation/algokit-cli">
+      <img src="https://img.shields.io/badge/docs-repository-00dc94?logo=github&style=flat.svg" />
+    </a>
+    <a target="_blank" href="https://developer.algorand.org/algokit/">
+      <img src="https://img.shields.io/badge/learn-AlgoKit-00dc94?logo=algorand&mac=flat.svg" />
+    </a>
+    <a target="_blank" href="https://github.com/algorandfoundation/algokit-beaker-default-template">
+      <img src="https://img.shields.io/github/stars/algorandfoundation/algokit-beaker-default-template?color=00dc94&logo=star&style=flat" />
+    </a>
+    <a target="_blank" href="https://developer.algorand.org/algokit/">
+      <img  src="https://api.visitorbadge.io/api/visitors?path=algorandfoundation%2Falgokit-beaker-default-template&countColor=%2300dc94&style=flat" />
+    </a>
+</p>
+
+---
 
 This template provides a production-ready baseline for developing and deploying [Beaker](https://github.com/algorand-devrel/beaker) smart contracts.
 
@@ -10,19 +29,20 @@ This is one of the official templates used by AlgoKit to initialise an Algorand
 
 This template supports the following features:
 
-* Compilation of [multiple Beaker contracts](template_content/smart_contracts/config.py) to a [predictable folder location and file layout](template_content/smart_contracts/__main__.py) where they can be deployed
-* Deploy-time immutability and permanence control
-* [Poetry](https://python-poetry.org/) for Python dependency management and virtual environment management
-* Linting via [Ruff](https://github.com/charliermarsh/ruff) or [Flake8](https://flake8.pycqa.org/en/latest/)
-* Formatting via [Black](https://github.com/psf/black)
-* Type checking via [mypy](https://mypy-lang.org/)
-* Testing via pytest (not yet used)
-* Dependency vulnerability scanning via pip-audit (not yet used)
-* VS Code configuration (linting, formatting, breakpoint debugging)
-* dotenv (.env) file for configuration
-* Automated testing of the compiled smart contracts
-* [Output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md) tests of the TEAL output
-* CI/CD pipeline using GitHub Actions
+-   Compilation of [multiple Beaker contracts](template_content/smart_contracts/config.py) to a [predictable folder location and file layout](template_content/smart_contracts/__main__.py) where they can be deployed
+-   Deploy-time immutability and permanence control
+-   [Poetry](https://python-poetry.org/) for Python dependency management and virtual environment management
+-   Linting via [Ruff](https://github.com/charliermarsh/ruff) or [Flake8](https://flake8.pycqa.org/en/latest/)
+-   Formatting via [Black](https://github.com/psf/black)
+-   Type checking via [mypy](https://mypy-lang.org/)
+-   Testing via pytest (not yet used)
+-   Dependency vulnerability scanning via pip-audit (not yet used)
+-   VS Code configuration (linting, formatting, breakpoint debugging)
+-   dotenv (.env) file for configuration
+-   Automated testing of the compiled smart contracts
+-   [Output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md) tests of the TEAL output
+-   CI/CD pipeline using GitHub Actions:
+-   -   Optionally pick deployments to Netlify or Vercel
 
 # Getting started