diff --git a/README.md b/README.md index 635e333d..6337f3bc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,23 @@ -# AlgoKit Beaker Template +
+ +
+ +

+ + + + + + + + + + + + +

+ +--- 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