diff --git a/README.md b/README.md index b41f922..b8aa8ba 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ A clean and modern Bootstrap-based template for phpDocumentor, designed to impro - Responsive and mobile-friendly - Styled code blocks and documentation elements - Improved tables of contents and element listings +- Designed for documentation sets that provide guides ## Installation @@ -28,7 +29,7 @@ composer require --dev fast-forward/phpdoc-bootstrap-template ## Usage -Reference the template from vendor in your phpdoc.xml: +Reference the template from vendor in your phpdoc.xml. This template is designed for projects that ship guides, and the guide output should point to the documentation root (`.`) so the guide index becomes the homepage: ```xml @@ -47,6 +48,12 @@ Reference the template from vendor in your phpdoc.xml: src + + + docs + + . +