adding docs workflow, update readme

Author: ellisonleao

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+on:
+  push:
+    branches:
+      - main
+name: docs
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: panvimdoc
+        uses: kdheepak/panvimdoc@main
+        with:
+          vimdoc: my-template-docs
+          version: "Neovim >= 0.8.0"
+          demojify: true
+          treesitter: true
+      - name: Push changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "auto-generate vimdoc"
+          commit_user_name: "github-actions[bot]"
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"
+          commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"

README.md

@@ -22,9 +22,11 @@ Click on `Use this template`
 ## Features and structure
 
 - 100% Lua
-- Github actions to run tests and check for formatting errors (Stylua)
-- Tests created with [busted](https://olivinelabs.com/busted/) + [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
-- luarocks release support (LUAROCKS_API_KEY secret configuration required)
+- Github actions for:
+  - running tests using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) and [busted](https://olivinelabs.com/busted/)
+  - check for formatting errors (Stylua)
+  - vimdocs autogeneration from README.md file
+  - luarocks release (LUAROCKS_API_KEY secret configuration required)
 
 ### Plugin structure