ivuorinen/gh-action-readme
1
0
Fork 0
mirror of https://github.com/ivuorinen/gh-action-readme.git synced 2026-01-26 03:04:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
gh-action-readme/docs/installation.md
Ismo Vuorinen 3fbb608f9f feat: update go version, renovate config, tooling, fixes (#28) 
* feat(deps): update go version, renovate config, tooling

* chore(deps): update google/go-github to v74

* feat(deps): migrate from yaml.v3 to goccy/go-yaml

* chore(deps): update goccy/go-yaml to v1.18.0 and address security concerns

* feat: improve issue templates and project configuration

- Update GitHub issue templates with CLI-specific fields for better bug reports
- Add specialized templates for documentation, theme, and performance issues
- Update pre-commit config to include comprehensive documentation linting
- Remove outdated Snyk configuration and security references
- Update Go version from 1.23+ to 1.24+ across project
- Streamline README.md organization and improve clarity
- Update CHANGELOG.md and CLAUDE.md formatting
- Create comprehensive CONTRIBUTING.md with development guidelines
- Remove TODO.md (replaced by docs/roadmap.md)
- Move SECURITY.md to docs/security.md

* docs: fix markdown linting violations across documentation

* fix: resolve template placeholder issues and improve uses statement generation

* fix: remove trailing whitespace from GitHub issue template
2025-08-07 05:22:44 +03:00

2.9 KiB
Raw Permalink Blame History

Installation

Multiple installation options are available for gh-action-readme.

📦 Binary Releases (Recommended)

Download pre-built binaries for your platform from the latest release.

Linux x86_64

curl -L https://github.com/ivuorinen/gh-action-readme/releases/latest/download/gh-action-readme_Linux_x86_64.tar.gz | tar -xz
sudo mv gh-action-readme /usr/local/bin/

macOS x86_64 (Intel)

curl -L https://github.com/ivuorinen/gh-action-readme/releases/latest/download/gh-action-readme_Darwin_x86_64.tar.gz | tar -xz
sudo mv gh-action-readme /usr/local/bin/

macOS ARM64 (Apple Silicon)

curl -L https://github.com/ivuorinen/gh-action-readme/releases/latest/download/gh-action-readme_Darwin_arm64.tar.gz | tar -xz
sudo mv gh-action-readme /usr/local/bin/

Windows x86_64

# PowerShell
Invoke-WebRequest -Uri "https://github.com/ivuorinen/gh-action-readme/releases/latest/download/gh-action-readme_Windows_x86_64.zip" -OutFile "gh-action-readme.zip"
Expand-Archive gh-action-readme.zip

🍺 Package Managers

Homebrew (macOS/Linux)

brew install ivuorinen/tap/gh-action-readme

Scoop (Windows)

scoop bucket add ivuorinen https://github.com/ivuorinen/scoop-bucket.git
scoop install gh-action-readme

Go Install

go install github.com/ivuorinen/gh-action-readme@latest

🐳 Docker

Run directly from Docker without installation:

# Latest release
docker run --rm -v $(pwd):/workspace ghcr.io/ivuorinen/gh-action-readme:latest gen

# Specific version
docker run --rm -v $(pwd):/workspace ghcr.io/ivuorinen/gh-action-readme:v1.0.0 gen

Docker Compose

version: '3.8'
services:
  gh-action-readme:
    image: ghcr.io/ivuorinen/gh-action-readme:latest
    volumes:
      - .:/workspace
    working_dir: /workspace

🔧 From Source

Prerequisites

  • Go 1.24+
  • Git

Build

git clone https://github.com/ivuorinen/gh-action-readme.git
cd gh-action-readme
make build

Install System-wide

sudo cp gh-action-readme /usr/local/bin/

✅ Verify Installation

gh-action-readme version
gh-action-readme --help

🔄 Updates

Binary/Package Manager

  • Homebrew: brew upgrade gh-action-readme
  • Scoop: scoop update gh-action-readme
  • Manual: Download new binary and replace existing

Docker

docker pull ghcr.io/ivuorinen/gh-action-readme:latest

Go Install

go install github.com/ivuorinen/gh-action-readme@latest

🚫 Uninstall

Binary Installation

sudo rm /usr/local/bin/gh-action-readme

Package Managers

  • Homebrew: brew uninstall gh-action-readme
  • Scoop: scoop uninstall gh-action-readme

Configuration Files

# Remove user configuration (optional)
rm -rf ~/.config/gh-action-readme/