From ac72bb5c7662656ce39cee38b4c308eecb5e1d9c Mon Sep 17 00:00:00 2001 From: Marc Jakobi Date: Fri, 5 Jan 2024 17:27:21 +0100 Subject: [PATCH] docs(readme): update --- README.md | 25 ++----------------------- 1 file changed, 2 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index e03a04e..3a2b5e2 100755 --- a/README.md +++ b/README.md @@ -26,21 +26,6 @@ with the [luarocks-tag-release action](https://github.com/nvim-neorocks/luarocks with [release-please](https://github.com/googleapis/release-please). - Automatically comment PRs with a review checklist. -## Setup - -1. Click on [Use this template](https://github.com/MrcJkb/nvim-lua-nix-plugin-template/generate) -to start a repo based on this template. **Do _not_ fork it**. -1. If your plugin depends on other plugins, -add them to [`nvim-wrapped` in the `ci-overlay.nix`](./nix/ci-overlay.nix). -1. Add the name of your plugin to [`flake.nix`](./flake.nix). -1. Add [`plenary.nvim`](https://github.com/nvim-lua/plenary.nvim) specs -to the `tests` directory. -1. Create a [LuaRocks API key](https://luarocks.org/settings/api-keys). -1. Add the API key to the repository's -[GitHub Actions secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository). -1. Text that needs to be updated is marked with `TODO:` comments. -1. Rename [`plugin-template.nvim-scm-1.rockspec`](./plugin-template.nvim-scm-1.rockspec) - ## Contributing All contributions are welcome! @@ -48,11 +33,5 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md). ## License -This template is [licensed according to GPL version 2](./LICENSE), -with the following exception: - -The license applies only to the Nix CI infrastructure provided by this template -repository, including any modifications made to the infrastructure. -Any software that uses or is derived from this template may be licensed under any -[OSI approved open source license](https://opensource.org/licenses/), -without being subject to the GPL version 2 license of this template. +This template is [licensed](./LICENSE) according to GPL version 2 +or (at your option) any later version.