https://github.com/weblidity/update-readme-cli-action

https://github.com/weblidity/update-readme-cli-action

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/weblidity/update-readme-cli-action
• Owner: weblidity
• License: mit
• Created: 2024-12-09T13:47:03.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-09T15:00:20.000Z (over 1 year ago)
• Last Synced: 2025-02-08T14:13:21.197Z (over 1 year ago)
• Language: JavaScript
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Update README CLI Action

This GitHub Action updates the README file with the usage section generated from the CLI.

## Usage

To use this action, create a workflow file (e.g., `.github/workflows/update-readme.yml`) in your repository with the following content:

```yaml

name: Update README CLI 

on:

  push:

    branches:

      - main

jobs:

  update-readme:

    runs-on: ubuntu-latest

    steps:

    - name: Checkout repository

      uses: actions/checkout@v2

    - name: Use Update README Action

      uses: weblidity/update-readme-cli-action@v3

      with:

        cli-path: './bin/cli.js'