From c8e29dd2e05ec575fcb97246c6534aec8a802b30 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20L=C3=B3pez?= Date: Tue, 29 Mar 2022 11:58:45 -0500 Subject: [PATCH 1/2] docs: update description --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index c9877d2..d808a22 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,9 @@ The Neovim package specification supports a single, top-level package metadata f * `summary` (String) a short description of the package, typically less than 100 character long. * `detailed` (String) a long-form description of the package, this should convey the package's principal functionality to the user without being as detailed as the package readme. * `homepage` (String) This is the homepage of the package, which in most cases will be the GitHub URL. + * `author` (Table) information about the author of the package. + * `name`: author name if there are multiple one can use e. 'plugin team' + * `email`: author email * `license` (String) This is [SPDX](https://spdx.org/licenses/) license identifier. Dual licensing is indicated via joining the relevant licenses via `/`. * `dependencies` (List[Table]) A list of tables describing the package dependencies. Each entry in the table has the following, only `source` is mandatory: From d6a2203e265443badf76e0fafda868be9c64fb38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20L=C3=B3pez?= Date: Tue, 29 Mar 2022 12:00:31 -0500 Subject: [PATCH 2/2] ci: automatic code examples updating --- .github/workflows/update_readme.yml | 21 +++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 25 insertions(+) create mode 100644 .github/workflows/update_readme.yml diff --git a/.github/workflows/update_readme.yml b/.github/workflows/update_readme.yml new file mode 100644 index 0000000..73f735f --- /dev/null +++ b/.github/workflows/update_readme.yml @@ -0,0 +1,21 @@ +name: Update README + +on: + push: + branches: + - master + paths: + - 'examples/**' + +jobs: + embed-code: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Markdown autodocs + uses: dineshsonachalam/markdown-autodocs@v1.0.4 + with: + commit_message: 'docs: update code examples' + # Optional output file paths, defaults to '[./README.md]'. + output_file_paths: '[./README.md]' + categories: '[code-block]' diff --git a/README.md b/README.md index d808a22..358741e 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,7 @@ The Neovim package specification supports a single, top-level package metadata f # Example + ```lua package = "lspconfig" version = "0.1.2" @@ -86,8 +87,10 @@ external_dependencies = { }, } ``` + And in json format + ```json { "package" : "lspconfig", @@ -117,6 +120,7 @@ And in json format } } ``` + # Guidelines for `packspec` implementers