Skip to content

Commit

Permalink
docs(readme): add link to example configurations wiki page (#13)
Browse files Browse the repository at this point in the history
* docs(readme): add link to example configurations wiki page

* docs(readme): add quick links
  • Loading branch information
mrcjkb authored Feb 17, 2023
1 parent 55159dc commit e3a7af1
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
Publishes packages to [LuaRocks](https://luarocks.org/) when a git tag is pushed.
No need to add a rockspec to your repository for each release (or at all).

## Quick links

- [Features](#features)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Inputs](#inputs)
- [Example configurations](https://github.com/nvim-neorocks/luarocks-tag-release/wiki/Example-configurations)
- [Limitations](#limitations)
- [Acknowledgements](#acknowledgements)

## Features

* Can generate a [rockspec](https://github.com/luarocks/luarocks/wiki/Rockspec-format) based on repository metadata and information provided to the action.
Expand Down Expand Up @@ -214,6 +224,9 @@ jobs:
> A `v` prefix (e.g. git tags such as `v1.0.0`) is also supported.
> It will be removed from the LuaRocks version.

## Example configurations

See the [Example configurations wiki page](https://github.com/nvim-neorocks/luarocks-tag-release/wiki/Example-configurations).

## Limitations

Expand Down

0 comments on commit e3a7af1

Please sign in to comment.