diff --git a/README.md b/README.md index 9af948f..64f3a53 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ # Statamic Anchor Navigation -> Statamic Anchor Navigation is a Statamic addon that helps you build a server side anchor navigation from your bard content. +A Statamic addon that provides a custom tag for creating an anchor nav for all headings generated by the bard editor. ## Features -This addon does: +- Extends the TipTap heading node and adds a slugified ID to all configured heading levels (defaults to h2). +- The `{{ anchor_navigation }}` tag makes it easy to build an anchor navigation for all headings within your bard content. -- Extends the TipTap Heading Node and adds a slugified ID to all heading levels of your choice. -- The 'anchor_navigation'-tag makes it easy to build an anchor navigation from headings in your bard content. - -## How to Install +## How to install You can search for this addon in the `Tools > Addons` section of the Statamic control panel and click **install**, or run the following command from your project root: @@ -17,9 +15,9 @@ You can search for this addon in the `Tools > Addons` section of the Statamic co composer require visuellverstehen/statamic-anchor-navigation ``` -## How to Use +## How to use -Include the anchor_navigation tag in your template and provide it with the field handle of your bard field. +Include the `{{ anchor_navigation }}` tag in your template and supply the field handle of your bard field. ```