From f054908a3f0f7a9291084483ec69d01cf057d877 Mon Sep 17 00:00:00 2001 From: Wisaroot Lertthaweedech Date: Fri, 11 Jul 2025 09:00:21 +0700 Subject: [PATCH] feat: update README.md --- .github/workflows/{ci.yml => pre-commit.yml} | 0 Makefile | 4 ---- README.md | 11 ++++++++--- 3 files changed, 8 insertions(+), 7 deletions(-) rename .github/workflows/{ci.yml => pre-commit.yml} (100%) diff --git a/.github/workflows/ci.yml b/.github/workflows/pre-commit.yml similarity index 100% rename from .github/workflows/ci.yml rename to .github/workflows/pre-commit.yml diff --git a/Makefile b/Makefile index 8ace469..eb4a953 100644 --- a/Makefile +++ b/Makefile @@ -14,10 +14,6 @@ setup_dev: assert_setup_dev: pre-commit run -a -ci: - chmod +x common/install_brew_packages.sh - ./common/install_brew_packages.sh - lint: find . -type f -name "*.sh" -exec shfmt -w -i 6 {} + find . -type f -name "*.sh" -exec shellcheck {} + diff --git a/README.md b/README.md index 492c5fd..26f0f59 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # Shared Scripts -Quick-share command line scripts for use in quick command runner like Makefile or Justfile. +This repository contains reusable shell scripts intended for use with quick command runners like Makefile or Justfile. +It is designed to be added as a Git submodule in other projects. ## Quick Start ```bash -make setup_dev # Install all dependencies and setup development environment -make assert_setup_dev # Validate setup +make setup_dev +make assert_setup_dev ``` ## Requirements @@ -17,10 +18,14 @@ make assert_setup_dev # Validate setup ## Usage +- Add as Submodule + ```bash git submodule add -b main https://github.com/wisarootl/shared-scripts.git scripts/shared ``` +- Example Makefile Usage + ```Makefile setup_dev: chmod +x scripts/shared/node/setup_dev.sh