https://github.com/miniontoby/tauri-plugin-list-generator-action
Tauri Plugin README List Generator Action
https://github.com/miniontoby/tauri-plugin-list-generator-action
actions generator tauri
Last synced: 2 months ago
JSON representation
Tauri Plugin README List Generator Action
- Host: GitHub
- URL: https://github.com/miniontoby/tauri-plugin-list-generator-action
- Owner: Miniontoby
- Created: 2023-07-06T14:21:49.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-14T12:56:27.000Z (almost 3 years ago)
- Last Synced: 2025-03-11T21:03:33.046Z (over 1 year ago)
- Topics: actions, generator, tauri
- Language: JavaScript
- Homepage:
- Size: 180 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tauri Plugin Workspace README file Generator
This action generates a README for Tauri Plugin Workspace, but it could also generate one for yours:
# How to use for other repo's
This action will also work for other repo's, if they meet these requirements:
- [X] Subprojects are inside a folder
- [X] All subprojects include a README.md
- [X] All README.md's are starting with a banner/image followed by the description (and an optional `- Supported platforms: (platforms here)`) and then `## Install`
Example:
```md
Automatically launch your application at startup.
- Supported platforms: Windows, Linux, and macOS.
## Install
There are three general methods of installation that we can recommend.
(...)
```
# Using the action
## Inputs
### `filename`
**Required** The path and filename of the output file. Default `README.md`.
### `folder`
**Required** The path of the folder including the plugins. Default `plugins`.
### `github-token`
**Required** Set to `${{ secrets.GITHUB_TOKEN }}`
## Example usage
```yaml
uses: Miniontoby/tauri_plugin_lister_action
with:
filename: README.md
folder: plugins
github-token: ${{ secrets.GITHUB_TOKEN }}
```