diff --git a/README.md b/README.md index 89ffab6..86d16c8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # MkDocs Quickstart -> A template, live demo and tutorial for how to setup a MkDocs docs site on GitHub Pages +> Started template for a MkDocs docs site on GH Pages - including CI [![CI status](https://github.com/MichaelCurrin/mkdocs-quickstart/workflows/Deploy%20docs/badge.svg)](https://github.com/MichaelCurrin/mkdocs-quickstart/actions) [![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/mkdocs-quickstart?include_prereleases=&sort=semver)](https://github.com/MichaelCurrin/mkdocs-quickstart/releases/) @@ -9,6 +9,8 @@ [![Made with MkDocs](https://img.shields.io/badge/MkDocs-~=1.1-blue)](https://www.mkdocs.org/) [![CI - GH Actions](https://img.shields.io/badge/CI-GH_Actions-blue?logo=github-actions&logoColor=white)](https://github.com/features/actions) +A template, live demo and tutorial for how to setup a MkDocs docs site on GH Pages. Using GitHub Actions to automated deploys. +